usr/src/man/man3dat/dat_cno_create.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH DAT_CNO_CREATE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_cno_create \- create a CNO instance
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <\fBdat/udat.h\fR>
  15
  16 DAT_RETURN
  17     dat_cno_create (
  18     IN    DAT_IA_HANDLE            \fIia_handle\fR,
  19     IN    DAT_OS_WAIT_PROXY_AGENT  \fIagent\fR,
  20     OUT   DAT_CNO_HANDLE           *\fIcno_handle\fR
  21     )
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIia_handle\fR\fR
  29 .ad
  30 .RS 14n
  31 Handle for an instance of DAT IA.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIagent\fR\fR
  38 .ad
  39 .RS 14n
  40 An optional OS Wait Proxy Agent that is to be invoked whenever CNO is invoked.
  41 \fBDAT_OS_WAIT_PROXY_AGENT_NULL\fR indicates that there is no proxy agent
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIcno_handle\fR\fR
  48 .ad
  49 .RS 14n
  50 Handle for the created instance of CNO.
  51 .RE
  52
  53 .SH DESCRIPTION
  54 .sp
  55 .LP
  56 The \fBdat_cno_create()\fR function creates a CNO instance. Upon creation,
  57 there are no Event Dispatchers feeding it.
  58 .sp
  59 .LP
  60 The \fIagent\fR parameter specifies the proxy agent, which is OS-dependent and
  61 which is invoked when the CNO is triggered. After it is invoked, it is no
  62 longer associated with the CNO. The value of \fBDAT_OS_WAIT_PROXY_AGENT_NULL\fR
  63 specifies that no OS Wait Proxy Agent is associated with the created CNO.
  64 .sp
  65 .LP
  66 Upon creation, the CNO is not associated with any EVDs, has no waiters and has,
  67 at most, one OS Wait Proxy Agent.
  68 .SH RETURN VALUES
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBDAT_SUCCESS\fR\fR
  73 .ad
  74 .RS 30n
  75 The operation was successful.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
  82 .ad
  83 .RS 30n
  84 The operation failed due to resource limitations.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBDAT_INVALID_HANDLE\fR\fR
  91 .ad
  92 .RS 30n
  93 The \fIia_handle\fR parameter is invalid.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBDAT_INVALID_PARAMETER\fR\fR
 100 .ad
 101 .RS 30n
 102 One of the parameters was invalid, out of range, or a combination of parameters
 103 was invalid, or the \fIagent\fR parameter is invalid.
 104 .RE
 105
 106 .SH ATTRIBUTES
 107 .sp
 108 .LP
 109 See \fBattributes\fR(5) for descriptions of the following attributes:
 110 .sp
 111
 112 .sp
 113 .TS
 114 box;
 115 c | c
 116 l | l .
 117 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 118 _
 119 Interface Stability     Standard: uDAPL, 1.1, 1.2
 120 _
 121 MT-Level        Safe
 122 .TE
 123
 124 .SH SEE ALSO
 125 .sp
 126 .LP
 127 \fBlibdat\fR(3LIB), \fBattributes\fR(5)