man/man3mpapi/MP_GetProprietaryLoadBalanceProperties.3mpapi

         te
 Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
 Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 MP_GETPROPRIETARYLOADBALANCEPROPERTIES 3MPAPI "Feb 15, 2006"
 NAME
MP_GetProprietaryLoadBalanceProperties - get load balance properties
 SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lMPAPI [ library.\|.\|. ]
#include <mpapi.h>

MP_STATUS MP_GetProprietaryLoadBalanceProperties(MP_OID oid,
 MP_PROPRIETARY_LOAD_BALANCE_PROPERTIES *pProps);


 PARAMETERS
oid

The object ID of the proprietary load balance.


pProps

A pointer to an object ID that has type
MP_PROPRIETARY_LOAD_BALANCE_PROPERTIES structure allocated by the caller.
With a successful return, this structure contains the properties of the
proprietary load balance algorithm specified by the oid.


 DESCRIPTION

The MP_GetProprietaryLoadBalanceProperties() function returns the
properties of the specified load balance.
 RETURN VALUES
MP_STATUS_INVALID_PARAMETER

The pObjectType is null or specifies a memory area to which data cannot
be written, or when the oid has a type subfield other than
MP_OBJECT_TYPE_PROPRIETARY_LOAD_BALANCE.


MP_STATUS_INVALID_OBJECT_TYPE

The oid does not specify any valid object type. This is most likely to
happen if an uninitialized object ID is passed to the API.


MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID or object sequence number is invalid.


MP_STATUS_SUCCESS

The operation is successful.


 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:


ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability
Standard: ANSI INCITS 412 Multipath Management API
MT-Level Safe


 SEE ALSO

libMPAPI(3LIB), MP_GetProprietaryLoadBalanceOidList(3MPAPI),
attributes(5)

Multipath Management API Version 1.0