usr/src/man/man3stmf/stmfAddToHostGroup.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 STMFADDTOHOSTGROUP 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfAddToHostGroup \- add an initiator port to an existing host group
   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 \fBstmfAddToHostGroup\fR(\fBstmfGroupName *\fR\fIhostGroupName\fR,
  16      \fBstmfDevid\fR \fIinitiatorName\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIhostGroupName\fR\fR
  24 .ad
  25 .RS 17n
  26 The name of the host group to which the specified initiatorName is added.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIinitiatorName\fR\fR
  33 .ad
  34 .RS 17n
  35 The device identifier of the initiator port to add to the specified host group.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBstmfAddToHostGroup()\fR function adds an initiator port to an existing
  42 host group.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 The following values are returned:
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBSTMF_ERROR_EXISTS\fR\fR
  51 .ad
  52 .RS 30n
  53 The specified \fIinitiatorName\fR already exists in this \fIhostGroupName\fR or
  54 in another host group in the system.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBSTMF_ERROR_GROUP_NOT_FOUND\fR\fR
  61 .ad
  62 .RS 30n
  63 The specified \fIhostGroupName\fR was not found in the system.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  70 .ad
  71 .RS 30n
  72 The API call was successful.
  73 .RE
  74
  75 .SH ATTRIBUTES
  76 .sp
  77 .LP
  78 See \fBattributes\fR(5) for descriptions of the following attributes:
  79 .sp
  80
  81 .sp
  82 .TS
  83 box;
  84 c | c
  85 l | l .
  86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  87 _
  88 Interface Stability     Committed
  89 _
  90 MT-Level        Safe
  91 .TE
  92
  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)