xref: /illumos-gate/usr/src/man/man3stmf/stmfGetHostGroupList.3stmf (revision 1e56f352c1c208679012bca47d552e127f5b1072)
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]
STMFGETHOSTGROUPLIST 3STMF "Jun 9, 2008"
NAME
stmfGetHostGroupList - retrieve the list of host groups
SYNOPSIS

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

int stmfGetInitiatorGroupList(stmfGroupList **hostGroupList);
PARAMETERS
hostGroupList

A pointer to a pointer to an stmfGroupList structure. On successful return, this will contain a list of host groups.

DESCRIPTION

The stmfGetInitiatorGroupList() function retrieves the list of host groups. The caller should call stmfFreeMemory(3STMF) when this list is no longer needed.

RETURN VALUES

The following values are returned: STMF_ERROR_NOMEM

The library was unable to allocate sufficient memory for hostGroupList.

STMF_STATUS_SUCCESS

The API call was successful.

ATTRIBUTES

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

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

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