xref: /illumos-gate/usr/src/man/man3stmf/stmfGetLogicalUnitProperties.3stmf (revision dd72704bd9e794056c558153663c739e2012d721)
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]
STMFGETLOGICALUNITPROPERTIES 3STMF "Jun 9, 2008"
NAME
stmfGetLogicalUnitProperties - retrieve the properties of the specified logical unit
SYNOPSIS

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

int stmfGetLogicalUnitProperties(stmfGuid *logicalUnit,
 stmfLogicalUnitProperties *logicalUnitProps);
PARAMETERS
logicalUnit

The identifier of the logical unit whose properties are being retrieved.

logicalUnitProps

A pointer to an stmfLogicalUnitProperties structure. On successful return, this will contain the properties for the specified logicalUnitOid.

DESCRIPTION

The stmfGetLogicalUnitProperties() function retrieves the properties of the specified logical unit.

RETURN VALUES

The following values are returned: STMF_ERROR_LOGICAL_UNIT_NOT_REGISTERED

The logicalUnit is not a valid registered logical unit in the system.

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), attributes (7)