xref: /illumos-gate/usr/src/man/man3dat/dat_pz_free.3dat (revision 1ed6b69a5ca1ca3ee5e9a4931f74e2237c7e1c9f)
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_PZ_FREE 3DAT "Jul 16, 2004"
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 Standard: uDAPL, 1.1, 1.2
MT-Level Unsafe
SEE ALSO

libdat(3LIB), attributes(5)