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

int stmfGetViewProp(viewResource \fIresource\fR, stmfViewPropType \fIpropType\fR,
      char *\fIpropVal\fR, size_t *\fIpropLen\fR);
.fi

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

.sp
.ne 2
.mk
.na
\fB\fIpropType\fR\fR
.ad
.sp .6
.RS 4n
Property type value. The following values are supported:
.sp
.ne 2
.mk
.na
\fB\fBSTMF_VE_PROP_GUID\fR\fR
.ad
.sp .6
.RS 4n
ASCII hexadecimal string of 32 characters representing the unique identifier for the logical unit to which the specified view resource is attached.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_VE_PROP_HG_ALL\fR\fR
.ad
.sp .6
.RS 4n
Set to "true" if host group was not specified while adding the view so that the associated logical unit is available to all initiators; otherwise it is set to "false".
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_VE_PROP_HG\fR\fR
.ad
.sp .6
.RS 4n
Host Group name attached to the specified view resource. This property is set to \fINULL\fR if \fBSTMF_VE_PROP_HG_ALL\fR is set to "true".
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_VE_PROP_TG_ALL\fR\fR
.ad
.sp .6
.RS 4n
Set to "true" if target group was not specified while adding the view so that the associated logical unit is available to all targets; otherwise it is set to "false".
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_VE_PROP_TG\fR\fR
.ad
.sp .6
.RS 4n
Target Group name attached to the specified view resource. This property is set to \fINULL\fR if \fBSTMF_VE_PROP_TG_ALL\fR is set to "true".
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_VE_PROP_IDX\fR\fR
.ad
.sp .6
.RS 4n
View entry index. The numeric value of the view entry, assigned by the system per logical unit.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_VE_PROP_LUN_TYPE\fR\fR
.ad
.sp .6
.RS 4n
Logical unit number type opted while adding the view entry, which is a directive for the system to map the associated logical unit for all initiators belonging to the host group of this view entry. The logical unit number type is either "fixed" or "auto" representing either a fixed LUN number or system-assigned automatic logical unit number.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_VE_PROP_LUN\fR\fR
.ad
.sp .6
.RS 4n
Fixed logical unit number. This property is valid only if a fixed logical unit number was opted while adding the view entry.
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fIpropVal\fR\fR
.ad
.sp .6
.RS 4n
Pointer to property value. The memory for \fIpropVal\fR needs to be allocated by the calling function.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpropLen\fR\fR
.ad
.sp .6
.RS 4n
The length of the property value. With the \fBstmfGetViewProp()\fR call, this parameter needs to be set with the length of the buffer allocated for \fIpropVal\fR. \fIpropLen\fR will be set to actual length of \fIproVal\fR on function return. In the case of insufficient size to hold the requested property value, \fIpropLen\fR will contain the actual size of the \fIpropVal\fR and \fBstmfGetViewProp()\fR will return \fBSTMF_ERROR_INVALID_ARG\fR.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfGetViewProp()\fR function obtains the property values of the specified view resource.
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_INVALID_ARG\fR\fR
.ad
.RS 26n
.rt  
One or more provided parameters are invalid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_NO_PROP_VAL\fR\fR
.ad
.RS 26n
.rt  
No value for the specified property
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_STATUS_SUCCESS\fR\fR
.ad
.RS 26n
.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), \fBstmfGetViewResourceList\fR(3STMF), \fBattributes\fR(5)