share/man/man3stmf/stmfGetTargetProperties.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 STMFGETTARGETPROPERTIES 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfGetTargetProperties \- retrieve the properties of the specified target port
   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 \fBstmfGetTargetProperties\fR(\fBstmfDevid *\fR\fItarget\fR,
  16      \fBstmfTargetProperties *\fR\fItargetProperties\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fItarget\fR\fR
  24 .ad
  25 .RS 20n
  26 The identifier of the target port whose properties are being retrieved.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fItargetProperties\fR\fR
  33 .ad
  34 .RS 20n
  35 A pointer to an \fBstmfTargetProperties\fR structure allocated by the caller.
  36 On successful return, the structure will contain the properties for the
  37 specified.
  38 .RE
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBstmfGetTargetProperties()\fR function retrieves the properties of the
  44 specified target port.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 The following values are returned:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
  53 .ad
  54 .RS 24n
  55 The specified target was not found in the system.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  62 .ad
  63 .RS 24n
  64 The API call was successful.
  65 .RE
  66
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 Interface Stability     Committed
  81 _
  82 MT-Level        Safe
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)