1 files changed, 78 insertions, 0 deletions
diff --git a/usr/src/man/man3stmf/stmfGetLogicalUnitList.3stmf b/usr/src/man/man3stmf/stmfGetLogicalUnitList.3stmf
new file mode 100644
index 0000000..c0adf4f
--- /dev/null
+++ b/usr/src/man/man3stmf/stmfGetLogicalUnitList.3stmf
@@ -0,0 +1,78 @@
+'\" te
+.\" Copyright (c) 2008, 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 STMFGETLOGICALUNITLIST 3STMF "Jun 9, 2008"
+.SH NAME
+stmfGetLogicalUnitList \- retrieve the list of logical units
+.SH SYNOPSIS
+.LP
+.nf
+cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
+#include <libstmf.h>
+
+\fBint\fR \fBstmfGetLogicalUnitList\fR(\fBstmfGuidList **\fR\fIlogicalUnitList\fR);
+.fi
+
+.SH PARAMETERS
+.sp
+.ne 2
+.na
+\fB\fIlogicalUnitList\fR\fR
+.ad
+.RS 19n
+A pointer to a pointer to an \fBstmfGuidList\fR structure. On successful
+return, this will contain a list of logical units in the system.
+.RE
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBstmfGetLogicalUnitList()\fR function retrieves the list of logical
+units. The caller should call \fBstmfFreeMemory\fR(3STMF) when this list is no
+longer needed.
+.SH RETURN VALUES
+.sp
+.LP
+The following values are returned:
+.sp
+.ne 2
+.na
+\fB\fBSTMF_ERROR_NOMEM\fR\fR
+.ad
+.RS 23n
+The library was unable to allocate sufficient memory for \fIlogicalUnitList\fR.
+.RE
+
+.sp
+.ne 2
+.na
+\fB\fBSTMF_STATUS_SUCCESS\fR\fR
+.ad
+.RS 23n
+The API call was successful.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+box;
+c | c
+l | l .
+ATTRIBUTE TYPE	ATTRIBUTE VALUE
+_
+Interface Stability	Committed
+_
+MT-Level	Safe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBstmfFreeMemory\fR(3STMF), \fBlibstmf\fR(3LIB), \fBattributes\fR(5)