usr/src/man/man3dat/dat_cno_modify_agent.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_MODIFY_AGENT 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_cno_modify_agent \- modify the OS Wait Proxy Agent
  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_modify_agent (
  18     IN    DAT_CNO_HANDLE            \fIcno_handle\fR,
  19     IN    DAT_OS_WAIT_PROXY_AGENT   \fIagent\fR
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIcno_handle\fR\fR
  28 .ad
  29 .RS 14n
  30 Handle for an instance of CNO
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIagent\fR\fR
  37 .ad
  38 .RS 14n
  39 Pointer to an optional OS Wait Proxy Agent to invoke whenever CNO is invoked.
  40 \fBDAT_OS_WAIT_PROXY_AGENT_NULL\fR indicates that there is no proxy agent.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBdat_cno_modify_agent()\fR function modifies the OS Wait Proxy Agent
  47 associated with a CNO. If non-null, any trigger received by the CNO is also
  48 passed to the OS Wait Proxy Agent. This is in addition to any local delivery
  49 through the CNO. The Consumer can pass the value of
  50 \fBDAT_OS_WAIT_PROXY_AGENT_NULL\fR to disassociate the current Proxy agent from
  51 the CNO
  52 .SH RETURN VALUES
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBDAT_SUCCESS\fR\fR
  57 .ad
  58 .RS 25n
  59 The operation was successful.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBDAT_INVALID_HANDLE\fR\fR
  66 .ad
  67 .RS 25n
  68 The \fIcno_handle\fR parameter is invalid.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  75 .ad
  76 .RS 25n
  77 One of the parameters was invalid, out of range, or a combination of parameters
  78 was invalid, or the \fIagent\fR parameter is invalid.
  79 .RE
  80
  81 .SH ATTRIBUTES
  82 .sp
  83 .LP
  84 See \fBattributes\fR(5) for descriptions of the following attributes:
  85 .sp
  86
  87 .sp
  88 .TS
  89 box;
  90 c | c
  91 l | l .
  92 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  93 _
  94 Interface Stability     Standard: uDAPL, 1.1, 1.2
  95 _
  96 MT-Level        Unsafe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBlibdat\fR(3LIB), \fBattributes\fR(5)