Manual Pages for UNIX Operating System command usage for man MP_GetProprietaryLoadBalanceOidList

Common Multipath Management Library Functions
                      MP_GetProprietaryLoadBalanceOidList(3MPAPI)



NAME
     MP_GetProprietaryLoadBalanceOidList - get a list  of  object
     IDs

SYNOPSIS
     cc [ flag... ] file... -lMPAPI [ library... ]
     #include 

     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 sub-
         field other than MP_OBJECT_TYPE_PLUGIN.


     MP_STATUS_OBJECT_NOT_FOUND

         The oid owner ID or object sequence number is invalid.



SunOS 5.11          Last change: 15 Feb 2006                    1






Common Multipath Management Library Functions
                      MP_GetProprietaryLoadBalanceOidList(3MPAPI)



     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  attri-
     butes:



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


SEE ALSO
     libMPAPI(3LIB),
     MP_GetProprietaryLoadBalanceProperties(3MPAPI),       attri-
     butes(5)


     Multipath Management API Version 1.0










SunOS 5.11          Last change: 15 Feb 2006                    2






Common Multipath Management Library Functions
                      MP_GetProprietaryLoadBalanceOidList(3MPAPI)






















































SunOS 5.11          Last change: 15 Feb 2006                    3