share/man/man3stmf/stmfCreateHostGroup.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 STMFCREATEHOSTGROUP 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfCreateHostGroup \- create a new 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 \fBstmfCreateHostGroup\fR(\fBstmfGroupName *\fR\fIhostGroupName\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIhostGroupName\fR\fR
  23 .ad
  24 .RS 17n
  25 The name of the host group to be created.
  26 .RE
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBstmfCreateHostGroup()\fR function creates a new host group.
  32 .SH RETURN VALUES
  33 .sp
  34 .LP
  35 The following values are returned:
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBSTMF_ERROR_EXISTS\fR\fR
  40 .ad
  41 .RS 25n
  42 The value specified for \fIhostGroupName\fR already exists in the system.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBSTMF_INVALID_ARGUMENT\fR\fR
  49 .ad
  50 .RS 25n
  51 The value specified for \fIhostGroupName\fR was not valid.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  58 .ad
  59 .RS 25n
  60 The API call was successful.
  61 .RE
  62
  63 .SH ATTRIBUTES
  64 .sp
  65 .LP
  66 See \fBattributes\fR(5) for descriptions of the following attributes:
  67 .sp
  68
  69 .sp
  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 Interface Stability     Committed
  77 _
  78 MT-Level        Safe
  79 .TE
  80
  81 .SH SEE ALSO
  82 .sp
  83 .LP
  84 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)