usr/src/man/man3slp/SLPGetProperty.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 SLPGETPROPERTY 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPGetProperty \- return SLP configuration property
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lslp\fR [ \fIlibrary\fR... ]
  13 #include <slp.h>
  14
  15 \fBconst char*\fR \fBSLPGetProperty\fR(\fBconst char*\fR \fIpcName\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBSLPGetProperty()\fR function returns the value of the  corresponding
  22 \fBSLP\fR  property  name,  or \fINULL\fR,  if  none.   If  there is no  error,
  23 \fBSLPGetProperty()\fR returns  a  pointer to the  property value.  If  the
  24 property  was not set, it returns  the empty string,  \fB""\fR.  If an  error
  25 occurs, \fBSLPGetProperty()\fR returns \fINULL\fR.  The returned string should
  26 not  be freed.
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIpcName\fR\fR
  32 .ad
  33 .RS 10n
  34 A null-terminated  string with the property name.   \fIpcName\fR cannot  be
  35 \fINULL\fR.
  36 .RE
  37
  38 .SH ERRORS
  39 .sp
  40 .LP
  41 This function or its callback may return any \fBSLP\fR error code. See the
  42 ERRORS section in \fBslp_api\fR(3SLP).
  43 .SH EXAMPLES
  44 .LP
  45 \fBExample 1 \fRUsing \fBSLPGetProperty()\fR
  46 .sp
  47 .LP
  48 Use the following example to return a list of configured scopes:
  49
  50 .sp
  51 .in +2
  52 .nf
  53 const char* useScopes
  54
  55 useScopes = SLPGetProperty("net.slp.useScopes");
  56 .fi
  57 .in -2
  58
  59 .SH ENVIRONMENT VARIABLES
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBSLP_CONF_FILE\fR\fR
  64 .ad
  65 .RS 17n
  66 When set, use this file for configuration.
  67 .RE
  68
  69 .SH SEE ALSO
  70 .sp
  71 .LP
  72 \fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBslp.conf\fR(4), \fBslpd.reg\fR(4),
  73 \fBattributes\fR(5)
  74 .sp
  75 .LP
  76 \fISystem Administration Guide: Network Services\fR
  77 .sp
  78 .LP
  79 Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The
  80 Internet Society. June 1999.