usr/src/man/man3slp/SLPSetProperty.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 SLPSETPROPERTY 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPSetProperty \- set an 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 \fBvoid\fR \fBSLPSetProperty\fR(\fBconst char *\fR\fIpcName\fR, \fBconst char *\fR\fIpcValue\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBSLPSetProperty()\fR function sets the value of the \fBSLP\fR property to
  22 the new value. The \fIpcValue\fR parameter contains the property value as a
  23 string.
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIpcName\fR\fR
  29 .ad
  30 .RS 11n
  31 A null-terminated  string with the property name.   \fIpcName\fR  cannot be
  32 \fINULL\fR.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIpcValue\fR\fR
  39 .ad
  40 .RS 11n
  41 A null-terminated string with the property value. \fIpcValue\fR  cannot be
  42 \fINULL\fR
  43 .RE
  44
  45 .SH ERRORS
  46 .sp
  47 .LP
  48 This function or its callback may return any \fBSLP\fR error code. See the
  49 ERRORS section in \fBslp_api\fR(3SLP).
  50 .SH EXAMPLES
  51 .LP
  52 \fBExample 1 \fRSetting a Configuration Property
  53 .sp
  54 .LP
  55 The following example shows to set the property \fBnet.slp.typeHint\fR to
  56 \fBservice:ftp\fR:
  57
  58 .sp
  59 .in +2
  60 .nf
  61 SLPSetProperty ("net.slp.typeHint" "service:ftp");
  62 .fi
  63 .in -2
  64
  65 .SH ENVIRONMENT VARIABLES
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBSLP_CONF_FILE\fR\fR
  70 .ad
  71 .RS 17n
  72 When set, use this file for configuration.
  73 .RE
  74
  75 .SH SEE ALSO
  76 .sp
  77 .LP
  78 \fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBslp.conf\fR(4), \fBslpd.reg\fR(4),
  79 \fBattributes\fR(5)
  80 .sp
  81 .LP
  82 \fISystem Administration Guide: Network Services\fR
  83 .sp
  84 .LP
  85 Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The
  86 Internet Society. June 1999.