Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

MP_GetProprietaryLoadBalanceOidList(3MPAPI)

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(7) for descriptions of the following attributes:

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

See Also

libMPAPI(3LIB), MP_GetProprietaryLoadBalanceProperties(3MPAPI), attributes(7)

Multipath Management API Version 1.0