share/man/man3stmf/stmfOnlineTarget.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 STMFONLINETARGET 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfOnlineTarget \- take online a target port that is currently in the offline
   9 state
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-lstmf\fR [ \fIlibrary \&.\|.\|.\fR ]
  14 #include <libstmf.h>
  15
  16 \fBint\fR \fBstmfOnlineTarget\fR(\fBstmfDevid *\fR\fItarget\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fItarget\fR\fR
  24 .ad
  25 .RS 10n
  26 The identifier of the target port to online.
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBstmfOnlineTarget()\fR function takes online a target port that is
  33 currently in the offline state.
  34 .SH RETURN VALUES
  35 .sp
  36 .LP
  37 The following values are returned:
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  42 .ad
  43 .RS 23n
  44 The API call was successful.
  45 .RE
  46
  47 .SH ATTRIBUTES
  48 .sp
  49 .LP
  50 See \fBattributes\fR(5) for descriptions of the following attributes:
  51 .sp
  52
  53 .sp
  54 .TS
  55 box;
  56 c | c
  57 l | l .
  58 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  59 _
  60 Interface Stability     Committed
  61 _
  62 MT-Level        Safe
  63 .TE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)