share/man/man3stmf/stmfGetState.3stmf

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH STMFGETSTATE 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfGetState \- retrieve the list of sessions on a target
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfGetState\fR(\fBstmfState *\fR\fIstate\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIstate\fR\fR
  23 .ad
  24 .RS 9n
  25 A pointer to an \fBstmfState\fR structure allocated by the caller.
  26 .RE
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBstmfGetState()\fR function retrieves the list of target port groups.
  32 .SH RETURN VALUES
  33 .sp
  34 .LP
  35 The following values are returned:
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  40 .ad
  41 .RS 23n
  42 The API call was successful.
  43 .RE
  44
  45 .SH ATTRIBUTES
  46 .sp
  47 .LP
  48 See \fBattributes\fR(5) for descriptions of the following attributes:
  49 .sp
  50
  51 .sp
  52 .TS
  53 box;
  54 c | c
  55 l | l .
  56 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  57 _
  58 Interface Stability     Committed
  59 _
  60 MT-Level        Safe
  61 .TE
  62
  63 .SH SEE ALSO
  64 .sp
  65 .LP
  66 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)