xref: /illumos-gate/usr/src/man/man3dat/dat_psp_query.3dat (revision a61ed2ce7a86a4d6428f2a83eb4739fae945447e)
te
This manual page is derived from the DAT/uDAPL 1.2 specification.
Portions Copyright (c) 2007, 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]
DAT_PSP_QUERY 3DAT "Jul 16, 2004"
NAME
dat_psp_query - provide parameters of the Public Service Point
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -ldat [ library.\|.\|. ]
#include <dat/udat.h>

DAT_RETURN
 dat_psp_query (
 IN DAT_PSP_HANDLE psp_handle,
 IN DAT_PSP_PARAM_MASK psp_param_mask,
 OUT DAT_PSP_PARAM *psp_param
 )
PARAMETERS
psp_handle

Handle for an instance of Public Service Point.

psp_param_mask

Mask for PSP parameters.

psp_param

Pointer to a Consumer-allocated structure that Provider fills for Consumer-requested parameters.

DESCRIPTION

The dat_psp_query() function provides to the Consumer parameters of the Public Service Point. Consumer passes in a pointer to the Consumer allocated structures for PSP parameters that Provider fills.

The psp_param_mask parameter allows Consumers to specify which parameters they would like to query. The Provider will return values for psp_param_mask requested parameters. The Provider may return the value for any of the other parameters.

RETURN VALUES
DAT_SUCCESS

The operation was successful.

DAT_INVALID_HANDLE

The psp_handle parameter is invalid.

DAT_INVALID_PARAMETER

The psp_param_mask parameter is invalid.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard: uDAPL, 1.1, 1.2
MT-Level Safe
SEE ALSO

libdat(3LIB), attributes(5)