diff options
author | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
---|---|---|
committer | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
commit | c10c16dec587a0662068f6e2991c29ed3a9db943 (patch) | |
tree | f414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi | |
parent | 68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff) | |
download | illumos-gate-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz |
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com
Reviewed by: gwr@nexenta.com
Reviewed by: trisk@opensolaris.org
Approved by: gwr@nexenta.com
--HG--
extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi')
-rw-r--r-- | usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi new file mode 100644 index 0000000000..aed4282a2c --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi @@ -0,0 +1,88 @@ +'\" 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] +.TH MP_GetLibraryProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetLibraryProperties \- get MP library properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetLibraryProperties\fR(\fBMP_LIBRARY_PROPERTIES\fR\fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type \fBMP_LIBRARY_PROPERTIES\fR structure +allocated by the caller. With a successful return, this structure contains the +properties of the MP library currently in use. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetLibraryProperties()\fR function gets the properties of the MP +library currently in use. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area that cannot be written to. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR |