man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: July 2014
 
 

dat_pz_free(3DAT)

Name

dat_pz_free - destroy an instance of the Protection Zone

Synopsis

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

DAT_RETURN
    dat_pz_free (
    IN    DAT_PZ_HANDLE    pz_handle
    )

Parameters

pz_handle

Handle for an instance of Protection Zone to be destroyed.

Description

The dat_pz_free() function destroys an instance of the Protection Zone. The Protection Zone cannot be destroyed if it is in use by an Endpoint, LMR, or RMR.

Use of the handle of the destroyed Protection Zone in any subsequent operation except for dat_pz_free() fails.

Return Values

DAT_SUCCESS

The operation was successful.

DAT_INVALID_STATE

Parameter in an invalid state. The Protection Zone was in use by Endpoint, LMR, or RMR instances.

DAT_INVALID_HANDLE

The pz_handle parameter is invalid.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Unsafe
Standard
uDAPL, 1.1, 1.2

See also

libdat(3LIB), attributes(5)