share/man/man3mpapi/MP_GetLibraryProperties.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_GETLIBRARYPROPERTIES 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetLibraryProperties \- get MP library properties
  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_GetLibraryProperties\fR(\fBMP_LIBRARY_PROPERTIES\fR\fI*pProps\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIpProps\fR\fR
  24 .ad
  25 .RS 10n
  26 A pointer to an object ID that has type \fBMP_LIBRARY_PROPERTIES\fR structure
  27 allocated by the caller. With a successful return, this structure contains the
  28 properties of the MP library currently in use.
  29 .RE
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The \fBMP_GetLibraryProperties()\fR function gets the properties of the MP
  35 library  currently in use.
  36 .SH RETURN VALUES
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  41 .ad
  42 .sp .6
  43 .RS 4n
  44 The \fIpProps\fR is null or specifies a memory area that cannot be written to.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBMP_STATUS_SUCCESS\fR\fR
  51 .ad
  52 .sp .6
  53 .RS 4n
  54 The operation is successful.
  55 .RE
  56
  57 .SH ATTRIBUTES
  58 .sp
  59 .LP
  60 See \fBattributes\fR(5) for descriptions of the following attributes:
  61 .sp
  62
  63 .sp
  64 .TS
  65 box;
  66 c | c
  67 l | l .
  68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  69 _
  70 Interface Stability     T{
  71 Standard: ANSI INCITS 412 Multipath Management API
  72 T}
  73 _
  74 MT-Level        Safe
  75 .TE
  76
  77 .SH SEE ALSO
  78 .sp
  79 .LP
  80 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
  81 .sp
  82 .LP
  83 \fIMultipath Management API Version 1.0\fR