xref: /illumos-gate/usr/src/man/man3slp/SLPFindScopes.3slp (revision 48bbca816818409505a6e214d0911fda44e622e3)
te
Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
SLPFINDSCOPES 3SLP "Jan 16, 2003"
NAME
SLPFindScopes - return list of configured and discovered scopes
SYNOPSIS

cc [ flag... ] file... -lslp [ library... ]
#include <slp.h>

SLPError SLPFindScopes(SLPHandle hSLP, char** ppcScopes);
DESCRIPTION

The SLPFindScopes() function sets the ppcScopes parameter to a pointer to a comma-separated list including all available scope names. The list of scopes comes from a variety of sources: the configuration file, the net.slp.useScopes property and the net.slp.DAAddresses property, DHCP, or through the DA discovery process. If there is any order to the scopes, preferred scopes are listed before less desirable scopes. There is always at least one string in the array, the default scope, DEFAULT.

If no error occurs, SLPFindScopes() returns SLP_OK, otherwise, it returns the appropriate error code.

PARAMETERS
hSLP

The SLPHandle on which to search for scopes. hSLP cannot be NULL.

ppcScopes

A pointer to a char pointer into which the buffer pointer is placed upon return. The buffer is null-terminated. The memory should be freed by calling SLPFree(). See SLPFree(3SLP)

ERRORS

This function or its callback may return any SLP error code. See the ERRORS section in slp_api(3SLP).

EXAMPLES

Example 1 Finding Configured or Discovered Scopes

Use the following example to find configured or discovered scopes:

SLPHandle hSLP;
char *ppcScopes;
SLPError err;

error = SLPFindScopes(hSLP, & ppcScopes);
ENVIRONMENT VARIABLES
SLP_CONF_FILE

When set, use this file for configuration.

SEE ALSO

slpd(1M), slp_api(3SLP), SLPFree(3SLP), slp.conf(4), slpd.reg(4), attributes(5)

System Administration Guide: Network Services

Guttman, E., Perkins, C., Veizades, J., and Day, M. RFC 2608, Service Location Protocol, Version 2. The Internet Society. June 1999.

Kempf, J. and Guttman, E. RFC 2614, An API for Service Location. The Internet Society. June 1999.