xref: /illumos-gate/usr/src/man/man3stmf/stmfGetHostGroupMembers.3stmf (revision edd580643f2cf1434e252cd7779e83182ea84945)
te
Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
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.
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.
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]
STMFGETHOSTGROUPMEMBERS 3STMF "Jun 9, 2008"
NAME
stmfGetHostGroupMembers - retrieve the properties of the specified host group
SYNOPSIS

cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>

int stmfGetHostGroupMembers(stmfGroupName *hostGroupName,
 stmfGroupProperties **groupProperties);
PARAMETERS
hostGroupName

The name of the host group whose member list is being retrieved.

groupProperties

A pointer to a pointer to an stmfGroupProperties structure. On successful return, this will contain the properties for the specified hostGroupName.

DESCRIPTION

The stmfGetHostGroupMembers() function retrieves the properties of the specified host group. The caller should call stmfFreeMemory(3STMF) when this list is no longer needed.

RETURN VALUES

The following values are returned: STMF_ERROR_NOT_FOUND

The specified hostGroupName was not found in the system.

STMF_STATUS_SUCCESS

The API call was successful.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO

stmfFreeMemory(3STMF), libstmf(3LIB), attributes(5)