xref: /titanic_41/usr/src/man/man3stmf/stmfGetProviderDataProt.3stmf (revision 49d3bc91e27cd871b950d56c01398fa2f2e12ab4) 
 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]
 stmfGetProviderDataProt 3STMF "7 Oct 2008" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
 NAME
stmfGetProviderDataProt - retrieve data for the specified provider

 SYNOPSIS


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

int stmfGetProviderDataProt(char *providerName, nvlist_t **nvl,
 int providerType, uint64_t *token);




 PARAMETERS

providerName


The name of the provider for which data is being retrieved.





nvl


A pointer to a pointer to an nvlist_t. On success, this will contain the
nvlist retrieved. The caller is responsible for freeing the returned nvlist by
calling nvlist_free(3NVPAIR).





providerType


The value for this parameter must be either STMF_LU_PROVIDER_TYPE or
STMF_PORT_PROVIDER_TYPE.





token


A pointer to a uint64_t allocated by the caller. On success, this will
contain a token for the returned data that can be used in a call to
stmfSetProviderDataProt(3STMF) to ensure that the data returned in this
call is not stale. If this value is NULL, the token will be ignored.




 DESCRIPTION

The stmfGetProviderDataProt() function retrieves the data for the
specified provider.

 RETURN VALUES

The following values are returned:


STMF_ERROR_NOMEM


The library was unable to allocate sufficient memory to return the data.





STMF_STATUS_SUCCESS


The API call was successful.




 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityCommitted
MT-LevelSafe



 SEE ALSO

libstmf(3LIB), nvlist_free(3NVPAIR),
stmfSetProviderDataProt(3STMF), attributes(5)