'\" te
.\" Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
.TH stmfGetViewResourceList 3STMF "25 Apr 2012" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
.SH NAME
stmfGetViewResourceList \- get a list of view entry resources for currently registered logical unit
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
#include <libstmf.h>

int stmfGetViewResourceList(stmfGuid *\fIlogicalUnit\fR,
      viewResourceList **\fIresourceList\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIlogicalUnit\fR\fR
.ad
.RS 16n
.rt  
The identifier of the logical unit to which the views entries are added.
.RE

.sp
.ne 2
.mk
.na
\fB\fIresourceList\fR\fR
.ad
.RS 16n
.rt  
A pointer to a pointer to structure \fBviewResourceList\fR. On successful return, this will contain list of view entry resources.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfGetViewResourceList()\fR function retrieves the list of view resources representing view entries attached to a specified logical unit. The \fIlogicalUnit\fR parameter must represent a currently registered STMF logical unit.
.sp
.LP
The caller should call \fBstmfFreeViewResourceList\fR(3STMF) when \fIresourceList\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
.RS 24n
.rt  
The API call was successful.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
.ad
.RS 24n
.rt  
The specified logical unit does not exist.
.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), \fBstmfFreeViewResourceList\fR(3STMF), \fBattributes\fR(5)