share/man/man3mpapi/MP_GetAssociatedPluginOid.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_GETASSOCIATEDPLUGINOID 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetAssociatedPluginOid \- get the object ID for the plugin
  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_GetAssociatedPluginOid\fR(\fBMP_OID\fR \fIoid\fR,
  17      \fBMP_OID\fR  \fI*pPluginOID\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIoid\fR\fR
  25 .ad
  26 .RS 14n
  27 The object ID of an object that has been received from a previous API call.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIpPluginOID\fR\fR
  34 .ad
  35 .RS 14n
  36 A pointer to an object ID that has type \fBMP_OID\fR structure allocated by the
  37 caller. With a successful return this will contain the object ID of the plugin
  38 associated with the object specified by the \fIoid\fR.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBMP_GetAssociatedPluginOid()\fR function gets the object ID for the
  45 plugin associated with the specified object ID. The sequence number subfield of
  46 the \fIoid\fR is not validate  since this API is implemented in the common
  47 library.
  48 .SH RETURN VALUES
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  53 .ad
  54 .sp .6
  55 .RS 4n
  56 The \fIoid\fR does not specify any valid object type. This is most likely to
  57 happen if an uninitialized object ID is passed to the API.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 The \fIpluginOid\fR is null or specifies a memory area to which data cannot be
  68 written.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  75 .ad
  76 .sp .6
  77 .RS 4n
  78 The \fIoid\fR owner ID is invalid.
  79 .RE
  80
  81 .SH ATTRIBUTES
  82 .sp
  83 .LP
  84 See \fBattributes\fR(5) for descriptions of the following attributes:
  85 .sp
  86
  87 .sp
  88 .TS
  89 box;
  90 c | c
  91 l | l .
  92 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  93 _
  94 Interface Stability     T{
  95 Standard: ANSI INCITS 412 Multipath Management API
  96 T}
  97 _
  98 MT-Level        Safe
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
 105 .sp
 106 .LP
 107 \fIMultipath Management API Version 1.0\fR