'\" te
.\" Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
.TH stmfGetViewLuNumberList 3STMF "23 Apr 2012" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
.SH NAME
stmfGetViewLuNumberList \- retrieve the list of logical-unit-numbers
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
#include <libstmf.h>

int stmfGetViewLuNumberList(viewResource \fIresource\fR,
      stmfLuNbrEntryList **\fIluNbrList\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIresource\fR\fR
.ad
.RS 13n
.rt  
A view resource previously allocated using \fBstmfGetViewResourceList\fR(3STMF) call.
.RE

.sp
.ne 2
.mk
.na
\fB\fIluNbrList\fR\fR
.ad
.RS 13n
.rt  
A pointer to a pointer to structure \fBstmfLuNbrEntryList\fR. On successful return, this will contain information of list of mapped logical-unit-numbers and the corresponding initiator for the given logical unit.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfGetViewLuNumberList()\fR function retrieves the list of logical-unit-numbers mapped at that time for a specified logical unit for all initiators associated with the host group in a view entry. A view entry can be added to a logical unit either by requesting a system assigned automatic logical-unit-number or by specifying a fixed logical-unit-number. If a logical-unit-number was specified while adding the view entry, all the mapped logical-unit-numbers will be same for all initiators associated to the host group in the view entry throughout the existence of that view. If an assigned automatic logical-unit-number was requested, the system may remap the number for any initiator associated to the view to avoid any possible conflict, in which case logical-unit-numbers may vary across the initiators associated with the host group of the view.
.sp
.LP
The caller should call \fBstmfFreeMemory\fR(3STMF) when \fIluNbrList\fR data is no longer needed.
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.mk
.na
\fB\fBSTMF_STATUS_SUCCESS\fR\fR
.ad
.sp .6
.RS 4n
The API call was successful.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_INVALID_ARG\fR\fR
.ad
.sp .6
.RS 4n
Invalid arguments passed
.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), \fBstmfFreeMemory\fR(3STMF), \fBstmfGetViewResourceList\fR(3STMF), \fBattributes\fR(5)