summaryrefslogtreecommitdiff
path: root/usr/src/man/man3stmf/stmfRemoveViewEntry.3stmf
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
committerRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
commitc10c16dec587a0662068f6e2991c29ed3a9db943 (patch)
treef414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3stmf/stmfRemoveViewEntry.3stmf
parent68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff)
downloadillumos-joyent-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/man3stmf/stmfRemoveViewEntry.3stmf')
-rw-r--r--usr/src/man/man3stmf/stmfRemoveViewEntry.3stmf95
1 files changed, 95 insertions, 0 deletions
diff --git a/usr/src/man/man3stmf/stmfRemoveViewEntry.3stmf b/usr/src/man/man3stmf/stmfRemoveViewEntry.3stmf
new file mode 100644
index 0000000000..096da811a5
--- /dev/null
+++ b/usr/src/man/man3stmf/stmfRemoveViewEntry.3stmf
@@ -0,0 +1,95 @@
+'\" 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 stmfRemoveViewEntry 3STMF "9 Jun 2008" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
+.SH NAME
+stmfRemoveViewEntry \- remove a view entry from the system
+.SH SYNOPSIS
+.LP
+.nf
+cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
+#include <libstmf.h>
+
+\fBint\fR \fBstmfRemoveViewEntry\fR(\fBstmfGuid *\fR\fIlogicalUnit\fR,
+ \fBuint32_t\fR \fIviewEntry\fR);
+.fi
+
+.SH PARAMETERS
+.sp
+.ne 2
+.mk
+.na
+\fB\fIlogicalUnit\fR\fR
+.ad
+.RS 15n
+.rt
+The identifier of the logical unit for the view entry being removed.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIviewEntry\fR\fR
+.ad
+.RS 15n
+.rt
+The numeric value of the view entry to be removed.
+.RE
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBstmfRemoveViewEntry()\fR function removes a view entry from the system.
+.SH RETURN VALUES
+.sp
+.LP
+The following values are returned:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
+.ad
+.RS 24n
+.rt
+The specified \fIlogicalUnit\fR or \fIviewEntryName\fR was not found in the
+system.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBSTMF_STATUS_SUCCESS\fR\fR
+.ad
+.RS 24n
+.rt
+The API call was 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 StabilityCommitted
+_
+MT-LevelSafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBlibstmf\fR(3LIB), \fBattributes\fR(5)