usr/src/man/man3dat/dat_registry_remove_provider.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_REGISTRY_REMOVE_PROVIDER 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_registry_remove_provider \- unregister the Provider from the Dynamic
  10 Registry
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  15 #include <\fBdat/udat.h\fR>
  16
  17 DAT_RETURN
  18     dat_registry_remove_provider  (
  19     IN       DAT_PROVIDER         *provider
  20     IN const DAT_PROVIDER_INFO    *provider_info
  21     )
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIprovider\fR\fR
  29 .ad
  30 .RS 17n
  31 Self-description of a Provider.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIprovider_info\fR\fR
  38 .ad
  39 .RS 17n
  40 Attributes of the Provider.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The Provider removes itself from the Dynamic Registry. It is the Provider's
  47 responsibility to complete its sessions. Removal of the registration only
  48 prevents new sessions.
  49 .sp
  50 .LP
  51 The Provider cannot be removed while it is in use. An attempt to remove the
  52 Provider while it is in use results in an error with the return code
  53 \fBDAT_PROVIDER_IN_USE\fR.
  54 .SH RETURN VALUES
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBDAT_SUCCESS\fR\fR
  59 .ad
  60 .RS 25n
  61 The operation was successful.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  68 .ad
  69 .RS 25n
  70 Invalid parameter. The Provider was not found.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBDAT_PROVIDER_IN_USE\fR\fR
  77 .ad
  78 .RS 25n
  79 The Provider was in use.
  80 .RE
  81
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Standard: uDAPL, 1.1, 1.2
  96 _
  97 MT-Level
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBlibdat\fR(3LIB), \fBattributes\fR(5)