usr/src/man/man3slp/SLPFindSrvs.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 SLPFINDSRVS 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPFindSrvs \- return service URLs
   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 \fBSLPFindSrvs\fR(\fBSLPHandle\fR \fIhSLP\fR, \fBconst char *\fR\fIpcServiceType\fR,
  16      \fBconst char *\fR\fIpcScopeList\fR,\ \fBconst char *\fR\fIpcSearchFilter\fR,
  17      \fBSLPSrvURLCallback *\fR\fIcallback\fR, \fBvoid *\fR\fIpvCookie\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBSLPFindSrvs()\fR function issues a request for \fBSLP\fR services. The
  24 query is for services on a language-specific \fBSLPHandle\fR. It returns the
  25 results through the \fIcallback\fR. The parameters will determine the results.
  26 .sp
  27 .LP
  28 If an error occurs  in starting the operation, one  of  the \fBSLPError\fR
  29 codes is returned.
  30 .SH PARAMETERS
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIhSLP\fR\fR
  35 .ad
  36 .RS 18n
  37 The language-specific \fBSLPHandle\fR on which to  search for services. It
  38 cannot  be \fINULL\fR.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIpcServiceType\fR\fR
  45 .ad
  46 .RS 18n
  47 The service type string for the request. The \fIpcServiceType\fR can be
  48 discovered by a call to \fBSLPSrvTypes()\fR. Examples of service type strings
  49 include
  50 .sp
  51 .in +2
  52 .nf
  53 "service:printer:lpr"
  54 .fi
  55 .in -2
  56
  57 or
  58 .sp
  59 .in +2
  60 .nf
  61 "service:nfs"
  62 .fi
  63 .in -2
  64
  65 \fIpcServiceType\fR cannot be \fINULL\fR.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fIpcScopeList\fR\fR
  72 .ad
  73 .RS 18n
  74 A pointer to a \fBchar\fR containing a comma-separated  list  of scope names.
  75 It cannot be \fINULL\fR or an empty string, \fB""\fR.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fIpcSearchFilter\fR\fR
  82 .ad
  83 .RS 18n
  84 A query formulated of attribute pattern matching expressions in the form of a
  85 \fBLDAPv3\fR search filter. See \fIRFC 2254\fR. If this filter is empty,
  86 \fB""\fR, all services of the requested type in the specified scopes are
  87 returned. It cannot be \fINULL\fR.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fIcallback\fR\fR
  94 .ad
  95 .RS 18n
  96 A callback through which the results of the operation are reported. It cannot
  97 be \fINULL\fR.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fIpvCookie\fR\fR
 104 .ad
 105 .RS 18n
 106 Memory passed to the callback code from the client. It can be \fINULL\fR.
 107 .RE
 108
 109 .SH ERRORS
 110 .sp
 111 .LP
 112 This function or its callback may return any \fBSLP\fR error code. See the
 113 ERRORS section in \fBslp_api\fR(3SLP).
 114 .SH EXAMPLES
 115 .LP
 116 \fBExample 1 \fRUsing \fBSLPFindSrvs()\fR
 117 .sp
 118 .LP
 119 The following example finds all advertisements for printers supporting the
 120 \fBLPR\fR protocol with the dpi attribute 300 in the default scope:
 121
 122 .sp
 123 .in +2
 124 .nf
 125 SLPError err;
 126 SLPHandle hSLP;
 127 SLPSrvURLCallback srvngst;
 128
 129 err = SLPFindSrvs(hSLP,
 130                   "service:printer:lpr",
 131                   "default",
 132                   "(dpi=300)",
 133                   srvngst,
 134                   NULL);
 135 .fi
 136 .in -2
 137
 138 .SH ENVIRONMENT VARIABLES
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fBSLP_CONF_FILE\fR\fR
 143 .ad
 144 .RS 17n
 145 When set, use this file for configuration.
 146 .RE
 147
 148 .SH SEE ALSO
 149 .sp
 150 .LP
 151 \fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBslp.conf\fR(4), \fBslpd.reg\fR(4),
 152 \fBattributes\fR(5)
 153 .sp
 154 .LP
 155 \fISystem Administration Guide: Network Services\fR
 156 .sp
 157 .LP
 158 Howes, T. \fIRFC 2254, The String Representation of LDAP Search Filters\fR. The
 159 Internet Society. 1997.
 160 .sp
 161 .LP
 162 Guttman, E.,  Perkins, C., Veizades, J., and Day, M. \fIRFC 2608, Service
 163 Location Protocol, Version 2\fR. The Internet Society. June 1999.
 164 .sp
 165 .LP
 166 Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The
 167 Internet Society. June 1999.