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

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

MP_STATUS MP_GetPluginOidList(MP_OID_LIST **ppList);


 PARAMETERS
ppList

A pointer to a pointer to an object ID that has type MP_OID_LIST. 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 of the plugins currently
loaded by the library.


 DESCRIPTION

The MP_GetPluginOidList() function returns a list of the object IDs of
all currently loaded plugins. The returned list is guaranteed to not contain
any duplicate entries.

When the caller is finished using the list it must free the memory used by the
list by calling MP_FreeOidList(3MPAPI).
 RETURN VALUES
MP_STATUS_INVALID_PARAMETER

The ppList is null or specifies a memory area to which data cannot be
written.


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.


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

Multipath Management API Version 1.0