usr/src/man/man3stmf/stmfDeleteHostGroup.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 STMFDELETEHOSTGROUP 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfDeleteHostGroup \- delete 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 \fBstmfDeleteHostGroup\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 being deleted.
  26 .RE
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBstmfDeleteHostGroup()\fR function deletes an existing 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_NOT_FOUND\fR\fR
  40 .ad
  41 .RS 24n
  42 The specified \fIhostGroupName\fR was not found in the system.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  49 .ad
  50 .RS 24n
  51 The API call was successful.
  52 .RE
  53
  54 .SH ATTRIBUTES
  55 .sp
  56 .LP
  57 See \fBattributes\fR(5) for descriptions of the following attributes:
  58 .sp
  59
  60 .sp
  61 .TS
  62 box;
  63 c | c
  64 l | l .
  65 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  66 _
  67 Interface Stability     Committed
  68 _
  69 MT-Level        Safe
  70 .TE
  71
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)