Current File : //usr/man/man3dat/dat_rmr_create.3dat

'\" te
.\" This manual page is derived from the DAT/uDAPL 1.2 specification.
.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.TH dat_rmr_create 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions"
.SH NAME
dat_rmr_create \- create an RMR for the specified Protection Zone
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <\fBdat/udat.h\fR>

DAT_RETURN
    dat_rmr_create(
    IN    DAT_PZ_HANDLE     pz_handle,
    OUT   DAT_RMR_HANDLE    *rmr_handle
    )
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIpz_handle\fR\fR
.ad
.RS 14n
.rt  
Handle for an instance of the Protection Zone.
.RE

.sp
.ne 2
.mk
.na
\fB\fIrmr_handle\fR\fR
.ad
.RS 14n
.rt  
Handle for the created instance of an RMR.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBdat_rmr_create()\fR function creates an RMR for the specified Protection Zone. This operation is relatively heavy. The created RMR can be bound to a memory region within the LMR through a lightweight \fBdat_rmr_bind\fR(3DAT) operation that generates \fIrmr_context\fR.
.sp
.LP
If the operation fails (does not return \fBDAT_SUCCESS\fR), the return values of \fIrmr_handle\fR are undefined and Consumers should not use them.
.sp
.LP
The \fIpz_handle\fR parameter provide Consumers a way to restrict access to an RMR by authorized connection only.
.SH RETURN VALUES
.sp
.ne 2
.mk
.na
\fB\fBDAT_SUCCESS\fR\fR
.ad
.RS 30n
.rt  
The operation was successful.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
.ad
.RS 30n
.rt  
The operation failed due to resource limitations.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDAT_INVALID_HANDLE\fR\fR
.ad
.RS 30n
.rt  
The \fIpz_handle\fR parameter is invalid.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
_
StandarduDAPL, 1.1, 1.2
.TE

.SH SEE ALSO
.sp
.LP
\fBdat_rmr_bind\fR(3DAT) , \fBlibdat\fR(3LIB), \fBattributes\fR(5)