usr/src/man/man3slp/SLPDereg.3slp

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SLPDEREG 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPDereg \- deregister the SLP advertisement
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lslp\fR [ \fIlibrary\fR... ]
  13 #include <slp.h>
  14
  15 \fBSLPError\fR \fBSLPDereg\fR(\fBSLPHandle\fR \fIhSLP\fR, \fBconst char *\fR\fIpcURL\fR,
  16      \fBSLPRegReport\fR \fIcallback\fR, \fBvoid *\fR\fIpvCookie\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBSLPDereg()\fR function deregisters the advertisement for \fBURL\fR
  23 \fIpcURL\fR in all scopes where the service is registered and in all language
  24 locales, not just the locale of the \fBSLPHandle\fR. If no error occurs, the
  25 return value is \fB0\fR. Otherwise, one of the \fBSLPError\fR codes is
  26 returned.
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIhSLP\fR\fR
  32 .ad
  33 .RS 12n
  34 The language specific  \fBSLPHandle\fR to use for deregistering. \fIhSLP\fR
  35 cannot be \fINULL\fR.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIpcURL\fR\fR
  42 .ad
  43 .RS 12n
  44 The \fBURL\fRto deregister. The value of \fIpcURL\fR cannot be \fINULL\fR.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIcallback\fR\fR
  51 .ad
  52 .RS 12n
  53 A callback to report the operation completion  status. \fIcallback\fR cannot be
  54 \fINULL\fR.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIpvCookie\fR\fR
  61 .ad
  62 .RS 12n
  63 Memory passed to the callback code from the client.  \fIpvCookie\fR can be
  64 \fINULL\fR.
  65 .RE
  66
  67 .SH ERRORS
  68 .sp
  69 .LP
  70 This function or its callback may return any \fBSLP\fR error code. See the
  71 ERRORS section in \fBslp_api\fR(3SLP).
  72 .SH EXAMPLES
  73 .LP
  74 \fBExample 1 \fRUsing \fBSLPDereg()\fR
  75 .sp
  76 .LP
  77 Use the following example to deregister the advertisement for the \fBURL\fR
  78 "\fBservice:ftp://csserver\fR":
  79
  80 .sp
  81 .in +2
  82 .nf
  83 SLPerror err;
  84 SLPHandle hSLP;
  85 SLPRegReport regreport;
  86
  87 err = SLPDereg(hSLP, "service:ftp://csserver", regreport, NULL);
  88 .fi
  89 .in -2
  90
  91 .SH ENVIRONMENT VARIABLES
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBSLP_CONF_FILE\fR\fR
  96 .ad
  97 .RS 17n
  98 When set, use this file for configuration.
  99 .RE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBslp.conf\fR(4), \fBslpd.reg\fR(4),
 105 \fBattributes\fR(5)
 106 .sp
 107 .LP
 108 \fISystem Administration Guide: Network Services\fR
 109 .sp
 110 .LP
 111 Guttman, E., Perkins, C., Veizades, J., and Day, M. \fIRFC 2608, Service
 112 Location Protocol, Version 2\fR. The Internet Society. June 1999.
 113 .sp
 114 .LP
 115 Kempf, J. and Guttman, E., \fIRFC 2614, An API for Service Location\fR, The
 116 Internet Society, June 1999.