You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
256 lines
10 KiB
256 lines
10 KiB
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<meta name="GENERATOR" content="Mozilla/4.77C-CCK-MCD Caldera Systems OpenLinux [en] (X11; U; Linux 2.4.2 i686) [Netscape]">
|
|
<title>OpenSLP Programmers Guide - SLPFindAttrs</title>
|
|
</head>
|
|
<body text="#000000" bgcolor="#FFFFFF" link="#0000EF" vlink="#51188E" alink="#FF0000">
|
|
|
|
<h2>
|
|
SLPFindAttrs</h2>
|
|
|
|
<hr WIDTH="100%">
|
|
<h3>
|
|
Declaration</h3>
|
|
<tt>#include <slp.h></tt>
|
|
<p><tt><a href="/SLPError.html">SLPError</a> SLPFindAttrs( <a href="SLPTypes.html#SLPHandle">SLPHandle</a>
|
|
<a href="#hslp">hslp</a>,</tt>
|
|
<br><tt>
|
|
const char* srvurl,</tt>
|
|
<br><tt>
|
|
const char* <a href="#scopelist">scopelist</a>,</tt>
|
|
<br><tt>
|
|
const char* attrids,</tt>
|
|
<br><tt>
|
|
<a href="SLPAttrCallback.html">SLPAttrCallback</a> <a href="#callback">callback</a>,</tt>
|
|
<br><tt>
|
|
void* <a href="#cookie">cookie</a>)</tt>
|
|
<h3>
|
|
Description</h3>
|
|
This function returns service attributes matching the <tt>attrids</tt>
|
|
for the indicated Service URL or service type. OpenSLP does
|
|
not support location of attributes by service type with <tt>attrids</tt>
|
|
containing wildcards (see status below).
|
|
<h3>
|
|
Parameters</h3>
|
|
|
|
<table BORDER CELLPADDING=5 NOSAVE >
|
|
<tr VALIGN=TOP NOSAVE>
|
|
<td NOSAVE><a NAME="hslp"></a><tt>hslp</tt></td>
|
|
|
|
<td NOSAVE>The language specific <tt>SLPHandle</tt> on which to search
|
|
for attributes the service.</td>
|
|
</tr>
|
|
|
|
<tr VALIGN=TOP NOSAVE>
|
|
<td NOSAVE><a NAME="srvurlorsrvtype"></a><tt>srvurl</tt></td>
|
|
|
|
<td NOSAVE>The service URL of the service to the attributes of. See
|
|
<a href="Syntax.html#Service Type">Syntax</a>
|
|
for more information SLP Service URLs.</td>
|
|
</tr>
|
|
|
|
<tr VALIGN=TOP NOSAVE>
|
|
<td NOSAVE><a NAME="attrids"></a><tt>attrids</tt></td>
|
|
|
|
<td>A comma separated list of attribute ids to return. Use the empty string
|
|
("") for all attributes. Wildcards are not supported.</td>
|
|
</tr>
|
|
|
|
<tr VALIGN=TOP NOSAVE>
|
|
<td><a NAME="scopelist"></a><tt>scopelist</tt></td>
|
|
|
|
<td NOSAVE>A pointer to a comma separated list of scope names. <i>May
|
|
be the empty string</i> if you wish to use scopes this machine is configured
|
|
for.. </td>
|
|
</tr>
|
|
|
|
<tr VALIGN=TOP NOSAVE>
|
|
<td><a NAME="callback"></a><tt>callback</tt></td>
|
|
|
|
<td NOSAVE>The address of an <a href="SLPAttrCallback.html">SLPAttrCallback</a>
|
|
function that will be called to report the results of the operation.
|
|
May not be NULL. See <a href="Callbacks.html">Callbacks</a> for more information
|
|
on how callbacks are used by the SLPAPI.</td>
|
|
</tr>
|
|
|
|
<tr VALIGN=TOP NOSAVE>
|
|
<td NOSAVE><a NAME="cookie"></a><tt>cookie</tt></td>
|
|
|
|
<td NOSAVE>Pointer to memory that gets passed to the callback code.
|
|
May be NULL.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>
|
|
Returns</h3>
|
|
|
|
<table BORDER NOSAVE >
|
|
<tr NOSAVE>
|
|
<td NOSAVE>SLP_OK</td>
|
|
|
|
<td>Indicates that the no error occurred during the operation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_PARSE_ERROR</td>
|
|
|
|
<td>The SLP message was rejected by a remote SLP agent. The API returns
|
|
this error only when no information was retrieved, and at least one SA
|
|
or DA indicated a protocol error. The data supplied through the API may
|
|
be malformed or a may have been damaged in transit.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_AUTHENTICATION_ABSENT</td>
|
|
|
|
<td>If the SLP framework supports authentication, this error arises when
|
|
the UA or SA failed to send an authenticator for requests or registrations.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_AUTHENTICATION_FAILED</td>
|
|
|
|
<td>If the SLP framework supports authentication, this error arises when
|
|
a authentication on an SLP message failed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_NETWORK_TIMED_OUT</td>
|
|
|
|
<td>When no reply can be obtained in the time specified by the configured
|
|
timeout interval for a unicast request, this error is returned. In
|
|
other words, slpd is running, but something is wrong with it</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_NETWORK_INIT_FAILED</td>
|
|
|
|
<td>If the network cannot initialize properly, this error is returned.
|
|
Will also be returned if an SA or DA agent (slpd) can not be contacted.
|
|
slpd must be running in order to call SLPReg() or SLPDereg().</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_MEMORY_ALLOC_FAILED </td>
|
|
|
|
<td>Out of memory error</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_PARAMETER_BAD</td>
|
|
|
|
<td>If a parameter passed into a function is bad, this error is returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_NETWORK_ERROR</td>
|
|
|
|
<td>The failure of networking during normal operations causes this error
|
|
to be returned. In OpenSLP, this is the error you'll get if an underlying
|
|
socket() call failed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_INTERNAL_SYSTEM_ERROR</td>
|
|
|
|
<td>A basic failure of the API causes this error to be returned. This occurs
|
|
when a system call or library fails. The operation could not recover.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SLP_HANDLE_IN_USE</td>
|
|
|
|
<td>Callback functions are not permitted to recursively call into the API
|
|
on the same SLPHandle, either directly or indirectly. If an attempt is
|
|
made to do so, this error is returned from the called API function.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If no service types can be found, no error is returned. However,
|
|
no calls (other than the SLP_LAST_CALL) will be made to the SLPSrvTypesCallback.
|
|
Be aware, especially if the call is async, of error codes that may be passed
|
|
to the <tt>SLPAttrCallback</tt> callback function.
|
|
<br>
|
|
<h3>
|
|
Status</h3>
|
|
|
|
<table CELLPADDING=5 NOSAVE >
|
|
<tr VALIGN=TOP NOSAVE>
|
|
<td NOSAVE>OpenSLP 0.9.1</td>
|
|
|
|
<td NOSAVE>Fully implemented as specified by RFC2614 except for finding
|
|
attributes by service type or with attrids containing wildcards.
|
|
These behaviors are expected to be depreciated in the next RFC 2614 revision.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>
|
|
See Also</h3>
|
|
<a href="SLPSrvTypeCallback.html">SLPSrvTypeCallback</a>, <a href="Syntax.html">Syntax</a>,
|
|
<a href="Callbacks.html">Callbacks</a>
|
|
<br>
|
|
<h3>
|
|
Example Code</h3>
|
|
|
|
<blockquote><tt>SLPBoolean myAttrCallback(SLPHandle hslp,</tt>
|
|
<br><tt>
|
|
const char* attrlist,</tt>
|
|
<br><tt>
|
|
SLPError errcode,</tt>
|
|
<br><tt>
|
|
void* cookie )</tt>
|
|
<br><tt>{</tt>
|
|
<br><tt> if(errcode == SLP_OK)</tt>
|
|
<br><tt> {</tt>
|
|
<br><tt> printf("%s\n",attrlist);</tt>
|
|
<br><tt> }</tt>
|
|
<p><tt> return SLP_FALSE;</tt>
|
|
<br><tt>}</tt>
|
|
<br>
|
|
<p><tt>int main(int argc, char* argv[])</tt>
|
|
<br><tt>{</tt>
|
|
<br><tt> SLPError result;</tt>
|
|
<br><tt> SLPHandle hslp;</tt>
|
|
<p><tt> if(SLPOpen("en",SLP_FALSE,&hslp) == SLP_OK)</tt>
|
|
<br><tt> {</tt>
|
|
<p><tt> result = SLPFindAttrs(hslp,</tt>
|
|
<br><tt>
|
|
"service:myservice.x://myhost.mydomain.org"</tt>
|
|
<br><tt>
|
|
"", /* return all attributes */</tt>
|
|
<br><tt>
|
|
"", /* use configured scopes */</tt>
|
|
<br><tt>
|
|
myAttrCallback,</tt>
|
|
<br><tt>
|
|
NULL);</tt>
|
|
<br><tt> if(result != SLP_OK)</tt>
|
|
<br><tt> {</tt>
|
|
<br><tt>
|
|
printf("errorcode: %i\n",result);</tt>
|
|
<br><tt> }</tt>
|
|
<p><tt> result = SLPFindAttrs(hslp,</tt>
|
|
<br><tt>
|
|
"service:myservice.x://myhost.mydomain.org"</tt>
|
|
<br><tt>
|
|
"attr1,attr2", /* return attr1 and attr1 only */</tt>
|
|
<br><tt>
|
|
"", /* use configured scopes */</tt>
|
|
<br><tt>
|
|
myAttrCallback,</tt>
|
|
<br><tt>
|
|
NULL);</tt>
|
|
<br><tt> if(result != SLP_OK)</tt>
|
|
<br><tt> {</tt>
|
|
<br><tt>
|
|
printf("errorcode: %i\n",result);</tt>
|
|
<br><tt> }</tt>
|
|
<p><tt> SLPClose(hslp);</tt>
|
|
<br><tt> }</tt>
|
|
<br><tt>}</tt></blockquote>
|
|
|
|
</body>
|
|
</html>
|