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

   1 '\" te
   2 .\" Copyright (c) 1999, 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 SLPFREE 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPFree \- frees memory
   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 \fBSLPFree\fR(\fBvoid *\fR\fIpvMem\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBSLPFree()\fR function frees memory returned from \fBSLPParseSrvURL()\fR,
  22 \fBSLPFindScopes()\fR,  \fBSLPEscape()\fR, and \fBSLPUnescape()\fR.
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIpvMem\fR\fR
  28 .ad
  29 .RS 9n
  30  A pointer to the storage allocated by the \fBSLPParseSrvURL()\fR,
  31 \fBSLPFindScopes()\fR, \fBSLPEscape()\fR, and \fBSLPUnescape()\fR functions.
  32 \fIpvMem\fR is ignored if its value is \fINULL\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 \fBSLPFree()\fR
  43 .sp
  44 .LP
  45 The following example illustrates how to call \fBSLPFree()\fR. It assumes that
  46 \fBSrvURL\fR contains previously allocated memory.
  47
  48 .sp
  49 .in +2
  50 .nf
  51 SLPerror err;
  52
  53 err = SLPFree((void*) SrvURL);
  54 .fi
  55 .in -2
  56
  57 .SH ENVIRONMENT VARIABLES
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBSLP_CONF_FILE\fR\fR
  62 .ad
  63 .RS 17n
  64 When set, use this file for configuration.
  65 .RE
  66
  67 .SH SEE ALSO
  68 .sp
  69 .LP
  70 \fBslpd\fR(1M), \fBSLPEscape\fR(3SLP), \fBSLPFindScopes\fR(3SLP),
  71 \fBSLPParseSrvURL\fR(3SLP), \fBSLPUnescape\fR(3SLP), \fBslp_api\fR(3SLP),
  72 \fBslp.conf\fR(4), \fBslpd.reg\fR(4), \fBattributes\fR(5)
  73 .sp
  74 .LP
  75 \fISystem Administration Guide: Network Services\fR
  76 .sp
  77 .LP
  78 Guttman, E.,  Perkins, C., Veizades, J., and Day, M. \fIRFC 2608, Service
  79 Location Protocol, Version 2\fR. The Internet Society. June 1999.
  80 .sp
  81 .LP
  82 Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The
  83 Internet Society. June 1999.