usr/src/man/man3mpapi/MP_GetPluginOidList.3mpapi

   1 '\" te
   2 .\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH MP_GETPLUGINOIDLIST 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetPluginOidList \- get a list of the object IDs
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <mpapi.h>
  15
  16 \fBMP_STATUS\fR \fBMP_GetPluginOidList\fR(\fBMP_OID_LIST\fR \fI**ppList\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIppList\fR\fR
  24 .ad
  25 .RS 10n
  26 A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR. With a
  27 successful return, this contains a pointer to an object ID that has type
  28 \fBMP_OID_LIST\fR that contains the object IDs of all of the plugins currently
  29 loaded by the library.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBMP_GetPluginOidList()\fR function returns a list of the object IDs of
  36 all currently loaded plugins. The returned list is guaranteed to not contain
  37 any duplicate entries.
  38 .sp
  39 .LP
  40 When the caller is finished using the list it must free the memory used by the
  41 list by calling \fBMP_FreeOidList\fR(3MPAPI).
  42 .SH RETURN VALUES
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  47 .ad
  48 .sp .6
  49 .RS 4n
  50 The \fIppList\fR is null or specifies a memory area to which data cannot be
  51 written.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBMP_STATUS_SUCCESS\fR\fR
  58 .ad
  59 .sp .6
  60 .RS 4n
  61 The operation is successful.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBMP_STATUS_FAILED\fR\fR
  68 .ad
  69 .sp .6
  70 .RS 4n
  71 The plugin for the specified object ID  is not found.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR
  78 .ad
  79 .sp .6
  80 .RS 4n
  81 A memory allocation failure occurred.
  82 .RE
  83
  84 .SH ATTRIBUTES
  85 .sp
  86 .LP
  87 See \fBattributes\fR(5) for descriptions of the following attributes:
  88 .sp
  89
  90 .sp
  91 .TS
  92 box;
  93 c | c
  94 l | l .
  95 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  96 _
  97 Interface Stability     T{
  98 Standard: ANSI INCITS 412 Multipath Management API
  99 T}
 100 _
 101 MT-Level        Safe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBlibMPAPI\fR(3LIB), \fBMP_FreeOidList\fR(3MPAPI),
 108 \fBMP_GetPluginProperties\fR(3MPAPI), \fBattributes\fR(5)
 109 .sp
 110 .LP
 111 \fIMultipath Management API Version 1.0\fR