xref: /illumos-gate/usr/src/man/man3dat/dat_cno_query.3dat (revision 8c0b080c8ed055a259d8cd26b9f005211c6a9753)
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_CNO_QUERY 3DAT "Jul 16, 2004"
NAME
dat_cno_query - provide the Consumer parameters of the CNO
SYNOPSIS

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

DAT_RETURN
 dat_cno_query (
 IN DAT_CNO_HANDLE cno_handle,
 IN DAT_CNO_PARAM_MASK cno_param_mask,
 OUT DAT_CNO_PARAM *cno_param
 )
PARAMETERS
cno_handle

Handle for the created instance of the Consumer Notification Object

cno_param_mask

Mask for CNO parameters

cno_param

Pointer to a Consumer-allocated structure that the Provider fills with CNO parameters

DESCRIPTION

The dat_cno_query() function provides the Consumer parameters of the CNO. The Consumer passes in a pointer to the Consumer-allocated structures for CNO parameters that the Provider fills.

The cno_param_mask parameter allows Consumers to specify which parameters to query. The Provider returns values for cno_param_mask requested parameters. The Provider can return values for any other parameters.

A value of DAT_OS_WAIT_PROXY_AGENT_NULL in cno_param indicates that there are no Proxy Agent associated with the CNO.

RETURN VALUES
DAT_SUCCESS

The operation was successful.

DAT_INVALID_PARAMETER

The cno_param_mask parameter is invalid.

DAT_INVALID_HANDLE

The cno_handle parameter is invalid.

ATTRIBUTES

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

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

libdat (3LIB), attributes (7)