share/man/man3mpapi/MP_GetDeviceProductProperties.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_GETDEVICEPRODUCTPROPERTIES 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetDeviceProductProperties \- get the properties of a specified device
  10 product
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  15 #include <mpapi.h>
  16
  17 \fBMP_STATUS\fR \fBMP_GetDeviceProductProperties\fR(\fBMP_OID\fR \fIoid\fR,
  18      \fBMP_DEVICE_PRODUCT_PROPERTIES\fR \fI*pProps\fR);
  19 .fi
  20
  21 .SH PARAMETERS
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fIoid\fR\fR
  26 .ad
  27 .RS 10n
  28 The object ID of the device product.
  29 .RE
  30
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIpProps\fR\fR
  35 .ad
  36 .RS 10n
  37 A pointer to an object ID that has type \fBMP_DEVICE_PR ODUCT_PROPERTIES\fR
  38 structure allocated by the caller. With a successful return, this structure
  39 contains the properties of the device product specified by the \fIoid\fR.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBMP_GetDeviceProductProperties()\fR function gets the properties of the
  46 specified device product.
  47 .SH RETURN VALUES
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  52 .ad
  53 .sp .6
  54 .RS 4n
  55 The \fIoid\fR does not specify any valid object type. This is most likely to
  56 happen if an uninitialized object ID is passed to the API.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  63 .ad
  64 .sp .6
  65 .RS 4n
  66 The \fIoid\fR owner ID or object sequence number is invalid.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  73 .ad
  74 .sp .6
  75 .RS 4n
  76 Returned when \fIpProps\fR is null or specifies a memory area to which data
  77 cannot be written, or the \fIoid\fR has a type subfield other than
  78 \fBMP_OBJECT_TYPE_DEVICE_PRODUCT\fR.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBMP_STATUS_SUCCESS\fR\fR
  85 .ad
  86 .sp .6
  87 .RS 4n
  88 The operation is successful.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBMP_STATUS_FAILED\fR\fR
  95 .ad
  96 .sp .6
  97 .RS 4n
  98 The plugin for the specified \fIoid\fR is not found.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
 105 .ad
 106 .sp .6
 107 .RS 4n
 108 The implementation does not support the API.
 109 .RE
 110
 111 .SH ATTRIBUTES
 112 .sp
 113 .LP
 114 See \fBattributes\fR(5) for descriptions of the following attributes:
 115 .sp
 116
 117 .sp
 118 .TS
 119 box;
 120 c | c
 121 l | l .
 122 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 123 _
 124 Interface Stability     T{
 125 Standard: ANSI INCITS 412 Multipath Management API
 126 T}
 127 _
 128 MT-Level        Safe
 129 .TE
 130
 131 .SH SEE ALSO
 132 .sp
 133 .LP
 134 \fBlibMPAPI\fR(3LIB), \fBMP_GetDeviceProductOidList\fR(3MPAPI),
 135 \fBattributes\fR(5)
 136 .sp
 137 .LP
 138 \fIMultipath Management API Version 1.0\fR