usr/src/man/man3slp/SLPFindScopes.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 SLPFINDSCOPES 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPFindScopes \- return list of configured and discovered scopes
   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 \fBSLPFindScopes\fR(\fBSLPHandle\fR \fIhSLP\fR, \fBchar**\fR \fIppcScopes\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBSLPFindScopes()\fR function sets the \fIppcScopes\fR parameter  to  a
  22 pointer to a comma-separated list including  all available scope  names. The
  23 list of  scopes comes from  a variety of  sources: the configuration file, the
  24 \fBnet.slp.useScopes\fR property and the \fBnet.slp.DAAddresses\fR  property,
  25 \fBDHCP\fR,   or  through the  \fBDA\fR discovery  process.  If  there is  any
  26 order  to the  scopes,  preferred  scopes  are  listed  before less  desirable
  27 scopes.  There  is  always  at  least one  string in the  array, the  default
  28 scope,  \fBDEFAULT\fR.
  29 .sp
  30 .LP
  31 If no error occurs, \fBSLPFindScopes()\fR returns \fBSLP_OK\fR, otherwise, it
  32 returns the appropriate error code.
  33 .SH PARAMETERS
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIhSLP\fR\fR
  38 .ad
  39 .RS 13n
  40 The \fBSLPHandle\fR on which to search for scopes.  \fIhSLP\fR cannot be
  41 \fINULL\fR.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIppcScopes\fR\fR
  48 .ad
  49 .RS 13n
  50 A  pointer to  a \fBchar\fR  pointer  into  which  the  buffer pointer is
  51 placed upon return. The buffer is null-terminated.   The memory should be freed
  52 by calling \fBSLPFree()\fR. See \fBSLPFree\fR(3SLP)
  53 .RE
  54
  55 .SH ERRORS
  56 .sp
  57 .LP
  58 This function or its callback may return any \fBSLP\fR error code. See the
  59 ERRORS section in \fBslp_api\fR(3SLP).
  60 .SH EXAMPLES
  61 .LP
  62 \fBExample 1 \fRFinding Configured or Discovered Scopes
  63 .sp
  64 .LP
  65 Use the following example to find configured or discovered scopes:
  66
  67 .sp
  68 .in +2
  69 .nf
  70 SLPHandle hSLP;
  71 char *ppcScopes;
  72 SLPError err;
  73
  74 error = SLPFindScopes(hSLP, & ppcScopes);
  75 .fi
  76 .in -2
  77
  78 .SH ENVIRONMENT VARIABLES
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBSLP_CONF_FILE\fR\fR
  83 .ad
  84 .RS 17n
  85 When set, use this file for configuration.
  86 .RE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBSLPFree\fR(3SLP), \fBslp.conf\fR(4),
  92 \fBslpd.reg\fR(4), \fBattributes\fR(5)
  93 .sp
  94 .LP
  95 \fISystem Administration Guide: Network Services\fR
  96 .sp
  97 .LP
  98 Guttman, E.,  Perkins, C., Veizades, J., and Day, M. \fIRFC 2608, Service
  99 Location Protocol, Version 2\fR. The Internet Society. June 1999.
 100 .sp
 101 .LP
 102 Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The
 103 Internet Society. June 1999.