usr/src/man/man3slp/SLPClose.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 SLPCLOSE 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPClose \- close an open SLP handle
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lslp\fR [ \fIlibrary\fR... ]
  13 #include <slp.h>
  14
  15 \fBvoid\fR  \fBSLPClose\fR(\fBSLPHandle\fR \fIphSLP\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBSLPClose()\fR function frees all  resources associated with the handle.
  22 If the handle is invalid, the function returns silently. Any outstanding
  23 synchronous or asynchronous operations are cancelled, so that their callback
  24 functions  will not be called any further
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIphSLP\fR\fR
  30 .ad
  31 .RS 9n
  32 An \fBSLPHandle\fR handle returned from a call to \fBSPLOpen()\fR.
  33 .RE
  34
  35 .SH ERRORS
  36 .sp
  37 .LP
  38 This function or its callback may return any \fBSLP\fR error code. See the
  39 ERRORS section in \fBslp_api\fR(3SLP).
  40 .SH EXAMPLES
  41 .LP
  42 \fBExample 1 \fRUsing \fBSLPClose()\fR
  43 .sp
  44 .LP
  45 The following example will free all resources associated the handle:
  46
  47 .sp
  48 .in +2
  49 .nf
  50 SLPHandle hslp
  51      SLPCLose(hslp);
  52 .fi
  53 .in -2
  54
  55 .SH ENVIRONMENT VARIABLES
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBSLP_CONF_FILE\fR\fR
  60 .ad
  61 .RS 17n
  62 When set, use this file for configuration.
  63 .RE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBslp.conf\fR(4), \fBslpd.reg\fR(4),
  69 \fBattributes\fR(5)
  70 .sp
  71 .LP
  72 \fISystem Administration Guide: Network Services\fR
  73 .sp
  74 .LP
  75 Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The
  76 Internet Society. June 1999.