man/man3mpapi/MP_GetProprietaryLoadBalanceOidList.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_GETPROPRIETARYLOADBALANCEOIDLIST 3MPAPI "Feb 15, 2006"
 NAME
MP_GetProprietaryLoadBalanceOidList - get a list of object IDs
 SYNOPSIS

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

MP_STATUS MP_GetProprietaryLoadBalanceOidList(MP_OID oid
 MP_OID_LIST **ppList);


 PARAMETERS
oid

The object ID of the plugin.


ppList

A pointer to a pointer to an object ID that has type MP_OID_LIST
structure. With a successful return, this contains a pointer to an object ID
that has type MP_OID_LIST that contains the object IDs of all the
proprietary load balance types associated with the specified plugin.


 DESCRIPTION

The MP_GetProprietaryLoadBalanceOidList() function returns a list of the
object IDs of all the proprietary load balance algorithms associated with this
plugin.

When the caller is finished using the list, it must free the memory used by the
list by calling MP_FreeOidList.
 RETURN VALUES
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_INVALID_PARAMETER

The ppList in null or specifies a memory area to which data cannot be
written, or if the oid has a type subfield other than
MP_OBJECT_TYPE_PLUGIN.


MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID or object sequence number is invalid.


MP_STATUS_SUCCESS

The operation is successful.


MP_STATUS_FAILED

The plugin for the specified object ID is not found.


MP_STATUS_INSUFFICIENT_MEMORY

A memory allocation failure occurred.


MP_STATUS_UNSUPPORTED

The implementation does not support the API.


 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_GetProprietaryLoadBalanceProperties(3MPAPI),
attributes(5)

Multipath Management API Version 1.0