DAT_GET_HANDLE_TYPE(3DAT) Direct Access Transport Library Functions

NAME

dat_get_handle_type - get handle type

SYNOPSIS

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

DAT_RETURN
dat_get_handle_typet (
IN DAT_HANDLE dat_handle,
OUT DAT_HANDLE_TYPE *handle_type
)

PARAMETERS

dat_handle
Handle for a DAT Object.


handle_type
Type of the handle of dat_handle.

DESCRIPTION

The dat_get_handle_type() function allows the Consumer to discover
the type of a DAT Object using its handle.


The dat_handle can be one of the following handle types:
DAT_IA_HANDLE, DAT_EP_HANDLE, DAT_EVD_HANDLE, DAT_CR_HANDLE,
DAT_RSP_HANDLE, DAT_PSP_HANDLE, DAT_PZ_HANDLE, DAT_LMR_HANDLE, or
DAT_RMR_HANDLE.


The handle_type is one of the following handle types:
DAT_HANDLE_TYPE_IA, DAT_HANDLE_TYPE_EP, DAT_HANDLE_TYPE_EVD,
DAT_HANDLE_TYPE_CR, DAT_HANDLE_TYPE_PSP, DAT_HANDLE_TYPE_RSP,
DAT_HANDLE_TYPE_PZ, DAT_HANDLE_TYPE_LMR, DAT_HANDLE_TYPE_RMR, or
DAT_HANDLE_TYPE_CNO.

RETURN VALUES

DAT_SUCCESS
The operation was successful.


DAT_INVALID_HANDLE
The dat_handle parameter is invalid.

USAGE

Consumers can use this operation to determine the type of Object
being returned. This is needed for calling an appropriate query or
any other operation on the Object handle.

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)

July 16, 2004 DAT_GET_HANDLE_TYPE(3DAT)