diff options
Diffstat (limited to 'usr/src/man/man3slp')
| -rw-r--r-- | usr/src/man/man3slp/SLPClose.3slp | 6 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPDelAttrs.3slp | 14 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPDereg.3slp | 12 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPEscape.3slp | 12 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPFindAttrs.3slp | 16 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPFindScopes.3slp | 8 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPFindSrvTypes.3slp | 14 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPFindSrvs.3slp | 24 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPFree.3slp | 6 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPGetProperty.3slp | 6 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPGetRefreshInterval.3slp | 4 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPOpen.3slp | 10 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPParseSrvURL.3slp | 8 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPReg.3slp | 20 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPSetProperty.3slp | 8 | ||||
| -rw-r--r-- | usr/src/man/man3slp/SLPUnescape.3slp | 10 | ||||
| -rw-r--r-- | usr/src/man/man3slp/slp_api.3slp | 163 | ||||
| -rw-r--r-- | usr/src/man/man3slp/slp_strerror.3slp | 6 |
18 files changed, 42 insertions, 305 deletions
diff --git a/usr/src/man/man3slp/SLPClose.3slp b/usr/src/man/man3slp/SLPClose.3slp index 8a0df94c57..d527972e0e 100644 --- a/usr/src/man/man3slp/SLPClose.3slp +++ b/usr/src/man/man3slp/SLPClose.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPClose 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPCLOSE 3SLP "Jan 16, 2003" .SH NAME SLPClose \- close an open SLP handle .SH SYNOPSIS @@ -25,12 +25,10 @@ functions will not be called any further .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIphSLP\fR\fR .ad .RS 9n -.rt An \fBSLPHandle\fR handle returned from a call to \fBSPLOpen()\fR. .RE @@ -57,12 +55,10 @@ SLPHandle hslp .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPDelAttrs.3slp b/usr/src/man/man3slp/SLPDelAttrs.3slp index 9c0d523488..b6bc921f0e 100644 --- a/usr/src/man/man3slp/SLPDelAttrs.3slp +++ b/usr/src/man/man3slp/SLPDelAttrs.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPDelAttrs 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPDELATTRS 3SLP "Jan 16, 2003" .SH NAME SLPDelAttrs \- delete attributes .SH SYNOPSIS @@ -25,59 +25,49 @@ Otherwise, one of the \fBSLPError\fR codes is returned. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 12n -.rt The language specific \fBSLPHandle\fR to use to delete attributes. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcURL\fR\fR .ad .RS 12n -.rt The \fB URL\fR of the advertisement from which the attributes should be deleted. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcAttrs\fR\fR .ad .RS 12n -.rt A comma-separated list of attribute ids for the attributes to deregister. .RE .sp .ne 2 -.mk .na \fB\fIcallback\fR\fR .ad .RS 12n -.rt A callback to report the operation's completion status. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 12n -.rt Memory passed to the callback code from the client. It cannot be \fINULL\fR. .RE @@ -109,12 +99,10 @@ err = SLPDelAttrs(hSLP, "service:printer:lpr://serv/queue1", .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPDereg.3slp b/usr/src/man/man3slp/SLPDereg.3slp index 67ea5ccb7e..ac9cd667ec 100644 --- a/usr/src/man/man3slp/SLPDereg.3slp +++ b/usr/src/man/man3slp/SLPDereg.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPDereg 3SLP "16 jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPDEREG 3SLP "Jan 16, 2003" .SH NAME SLPDereg \- deregister the SLP advertisement .SH SYNOPSIS @@ -27,47 +27,39 @@ returned. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 12n -.rt The language specific \fBSLPHandle\fR to use for deregistering. \fIhSLP\fR cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcURL\fR\fR .ad .RS 12n -.rt The \fBURL\fRto deregister. The value of \fIpcURL\fR cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIcallback\fR\fR .ad .RS 12n -.rt A callback to report the operation completion status. \fIcallback\fR cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 12n -.rt Memory passed to the callback code from the client. \fIpvCookie\fR can be \fINULL\fR. .RE @@ -99,12 +91,10 @@ err = SLPDereg(hSLP, "service:ftp://csserver", regreport, NULL); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPEscape.3slp b/usr/src/man/man3slp/SLPEscape.3slp index 6ee311a076..25397146d7 100644 --- a/usr/src/man/man3slp/SLPEscape.3slp +++ b/usr/src/man/man3slp/SLPEscape.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPEscape 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPESCAPE 3SLP "Jan 16, 2003" .SH NAME SLPEscape \- escapes SLP reserved characters .SH SYNOPSIS @@ -29,23 +29,19 @@ into a buffer allocated by the \fBAPI\fR library and returned in the .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIpcInBuf\fR\fR .ad .RS 13n -.rt Pointer to the input buffer to process for escape characters. .RE .sp .ne 2 -.mk .na \fB\fIppcOutBuf\fR\fR .ad .RS 13n -.rt Pointer to a pointer for the output buffer with the \fBSLP\fR reserved characters escaped. It must be freed using \fBSLPFree()\fR when the memory is no longer needed. @@ -53,12 +49,10 @@ no longer needed. .sp .ne 2 -.mk .na \fB\fIisTag\fR\fR .ad .RS 13n -.rt When true, checks the input buffer for bad tag characters. .RE @@ -81,19 +75,17 @@ The following example shows how to convert the attribute tag SLPError err; char* escaped Chars; -err = SLPEscape(",tag-example,", &escapedChars, SLP_TRUE); +err = SLPEscape(",tag-example,", &escapedChars, SLP_TRUE); .fi .in -2 .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPFindAttrs.3slp b/usr/src/man/man3slp/SLPFindAttrs.3slp index 514fb5d3cd..f0f5c7ab7d 100644 --- a/usr/src/man/man3slp/SLPFindAttrs.3slp +++ b/usr/src/man/man3slp/SLPFindAttrs.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPFindAttrs 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPFINDATTRS 3SLP "Jan 16, 2003" .SH NAME SLPFindAttrs \- return service attributes .SH SYNOPSIS @@ -39,48 +39,40 @@ is returned. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 15n -.rt The language-specific \fBSLPHandle\fR on which to search for attributes. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcURL\fR\fR .ad .RS 15n -.rt The full or partial \fBURL\fR. See \fIRFC 2608\fR for partial \fBURL\fR syntax. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcScopeList\fR\fR .ad .RS 15n -.rt A pointer to a \fBchar\fR containing a comma-separated list of scope names. It cannot be \fINULL\fR or an empty string, \fB""\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcAttrIds\fR\fR .ad .RS 15n -.rt The filter string indicating which attribute values to return. Use empty string \fB""\fR to indicate all values. Wildcards matching all attribute ids having a particular prefix or suffix are also possible. It cannot be @@ -89,24 +81,20 @@ having a particular prefix or suffix are also possible. It cannot be .sp .ne 2 -.mk .na \fB\fIcallback\fR\fR .ad .RS 15n -.rt A callback function through which the results of the operation are reported. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 15n -.rt Memory passed to the callback code from the client. It may be \fINULL\fR. .RE @@ -156,12 +144,10 @@ err = SLPFindAttrs(hSLP, "service:printer:lpr", .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPFindScopes.3slp b/usr/src/man/man3slp/SLPFindScopes.3slp index 8c45fe3614..e422616991 100644 --- a/usr/src/man/man3slp/SLPFindScopes.3slp +++ b/usr/src/man/man3slp/SLPFindScopes.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPFindScopes 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPFINDSCOPES 3SLP "Jan 16, 2003" .SH NAME SLPFindScopes \- return list of configured and discovered scopes .SH SYNOPSIS @@ -33,24 +33,20 @@ returns the appropriate error code. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 13n -.rt The \fBSLPHandle\fR on which to search for scopes. \fIhSLP\fR cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIppcScopes\fR\fR .ad .RS 13n -.rt A pointer to a \fBchar\fR pointer into which the buffer pointer is placed upon return. The buffer is null-terminated. The memory should be freed by calling \fBSLPFree()\fR. See \fBSLPFree\fR(3SLP) @@ -82,12 +78,10 @@ error = SLPFindScopes(hSLP, & ppcScopes); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPFindSrvTypes.3slp b/usr/src/man/man3slp/SLPFindSrvTypes.3slp index 3cd19d80c3..121872939b 100644 --- a/usr/src/man/man3slp/SLPFindSrvTypes.3slp +++ b/usr/src/man/man3slp/SLPFindSrvTypes.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPFindSrvTypes 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPFINDSRVTYPES 3SLP "Jan 16, 2003" .SH NAME SLPFindSrvTypes \- find service types .SH SYNOPSIS @@ -54,23 +54,19 @@ is returned. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 21n -.rt The \fBSLPHandle\fR on which to search for types. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcNamingAuthority\fR\fR .ad .RS 21n -.rt The naming authority to search. Use "\fB*\fR"to search all naming authorties; use the empty string \fB""\fR to search the default naming authority. It cannot be \fINULL\fR. @@ -78,36 +74,30 @@ be \fINULL\fR. .sp .ne 2 -.mk .na \fB\fIpcScopeList\fR\fR .ad .RS 21n -.rt A pointer to a \fBchar\fR containing a comma-separated list of scope names to search for service types. It cannot be \fINULL\fR or an empty string, \fB""\fR. .RE .sp .ne 2 -.mk .na \fB\fIcallback\fR\fR .ad .RS 21n -.rt A callback through which the results of the operation are reported. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 21n -.rt Memory passed to the callback code from the client. It can be \fINULL\fR. .RE @@ -138,12 +128,10 @@ err = SLPFindSrvTypes(hSLP, "", "default", findsrvtypes, NULL); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPFindSrvs.3slp b/usr/src/man/man3slp/SLPFindSrvs.3slp index 8fcb269c85..346c00f213 100644 --- a/usr/src/man/man3slp/SLPFindSrvs.3slp +++ b/usr/src/man/man3slp/SLPFindSrvs.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPFindSrvs 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPFINDSRVS 3SLP "Jan 16, 2003" .SH NAME SLPFindSrvs \- return service URLs .SH SYNOPSIS @@ -30,24 +30,20 @@ codes is returned. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 18n -.rt The language-specific \fBSLPHandle\fR on which to search for services. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcServiceType\fR\fR .ad .RS 18n -.rt The service type string for the request. The \fIpcServiceType\fR can be discovered by a call to \fBSLPSrvTypes()\fR. Examples of service type strings include @@ -71,24 +67,20 @@ or .sp .ne 2 -.mk .na \fB\fIpcScopeList\fR\fR .ad .RS 18n -.rt A pointer to a \fBchar\fR containing a comma-separated list of scope names. It cannot be \fINULL\fR or an empty string, \fB""\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcSearchFilter\fR\fR .ad .RS 18n -.rt A query formulated of attribute pattern matching expressions in the form of a \fBLDAPv3\fR search filter. See \fIRFC 2254\fR. If this filter is empty, \fB""\fR, all services of the requested type in the specified scopes are @@ -97,24 +89,20 @@ returned. It cannot be \fINULL\fR. .sp .ne 2 -.mk .na \fB\fIcallback\fR\fR .ad .RS 18n -.rt A callback through which the results of the operation are reported. It cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 18n -.rt Memory passed to the callback code from the client. It can be \fINULL\fR. .RE @@ -139,10 +127,10 @@ SLPHandle hSLP; SLPSrvURLCallback srvngst; err = SLPFindSrvs(hSLP, - "service:printer:lpr", - "default", - "(dpi=300)", - srvngst, + "service:printer:lpr", + "default", + "(dpi=300)", + srvngst, NULL); .fi .in -2 @@ -150,12 +138,10 @@ err = SLPFindSrvs(hSLP, .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPFree.3slp b/usr/src/man/man3slp/SLPFree.3slp index 4360599dc3..cf58dacdfa 100644 --- a/usr/src/man/man3slp/SLPFree.3slp +++ b/usr/src/man/man3slp/SLPFree.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPFree 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPFREE 3SLP "Jan 16, 2003" .SH NAME SLPFree \- frees memory .SH SYNOPSIS @@ -23,12 +23,10 @@ The \fBSLPFree()\fR function frees memory returned from \fBSLPParseSrvURL()\fR, .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIpvMem\fR\fR .ad .RS 9n -.rt A pointer to the storage allocated by the \fBSLPParseSrvURL()\fR, \fBSLPFindScopes()\fR, \fBSLPEscape()\fR, and \fBSLPUnescape()\fR functions. \fIpvMem\fR is ignored if its value is \fINULL\fR. @@ -59,12 +57,10 @@ err = SLPFree((void*) SrvURL); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPGetProperty.3slp b/usr/src/man/man3slp/SLPGetProperty.3slp index e6989a341d..95ec821ee4 100644 --- a/usr/src/man/man3slp/SLPGetProperty.3slp +++ b/usr/src/man/man3slp/SLPGetProperty.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPGetProperty 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPGETPROPERTY 3SLP "Jan 16, 2003" .SH NAME SLPGetProperty \- return SLP configuration property .SH SYNOPSIS @@ -27,12 +27,10 @@ not be freed. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIpcName\fR\fR .ad .RS 10n -.rt A null-terminated string with the property name. \fIpcName\fR cannot be \fINULL\fR. .RE @@ -61,12 +59,10 @@ useScopes = SLPGetProperty("net.slp.useScopes"); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPGetRefreshInterval.3slp b/usr/src/man/man3slp/SLPGetRefreshInterval.3slp index 20db24bcb6..6f17543a4a 100644 --- a/usr/src/man/man3slp/SLPGetRefreshInterval.3slp +++ b/usr/src/man/man3slp/SLPGetRefreshInterval.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPGetRefreshInterval 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPGETREFRESHINTERVAL 3SLP "Jan 16, 2003" .SH NAME SLPGetRefreshInterval \- return the maximum allowed refresh interval .SH SYNOPSIS @@ -48,12 +48,10 @@ minrefresh = SLPGetRefreshInterval(\|); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPOpen.3slp b/usr/src/man/man3slp/SLPOpen.3slp index 51ddd03a44..5788b64063 100644 --- a/usr/src/man/man3slp/SLPOpen.3slp +++ b/usr/src/man/man3slp/SLPOpen.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPOpen 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPOPEN 3SLP "Jan 16, 2003" .SH NAME SLPOpen \- open an SLP handle .SH SYNOPSIS @@ -39,12 +39,10 @@ calls on the handle. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIpcLang\fR\fR .ad .RS 11n -.rt A pointer to an array of characters containing the language tag set forth in \fIRFC 1766\fR for the natural language locale of requests issued on the handle. This parameter cannot be \fINULL\fR. @@ -52,24 +50,20 @@ handle. This parameter cannot be \fINULL\fR. .sp .ne 2 -.mk .na \fB\fIisAsync\fR\fR .ad .RS 11n -.rt An \fBSLPBoolean\fR indicating whether or not the \fBSLPHandle\fR should be opened for an asynchronous operation. .RE .sp .ne 2 -.mk .na \fB\fIphSLP\fR\fR .ad .RS 11n -.rt A pointer to an \fBSLPHandle\fR in which the open \fBSLPHandle\fR is returned. If an error occurs, the value upon return is \fINULL\fR. .RE @@ -97,12 +91,10 @@ SLPHandle HSLP; SLPError err; err = SLPOpen("de", SLP_FALSE, &hSLP) .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPParseSrvURL.3slp b/usr/src/man/man3slp/SLPParseSrvURL.3slp index 85ebe25f07..49fde717a8 100644 --- a/usr/src/man/man3slp/SLPParseSrvURL.3slp +++ b/usr/src/man/man3slp/SLPParseSrvURL.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPParseSrvURL 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPPARSESRVURL 3SLP "Jan 16, 2003" .SH NAME SLPParseSrvURL \- parse service URL .SH SYNOPSIS @@ -36,12 +36,10 @@ error occurs, one of the \fBSLPError\fR codes is returned. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIpcSrvURL\fR\fR .ad .RS 12n -.rt A pointer to a character buffer containing the null terminated URL string to parse. It is destructively modified to produce the output structure. It may not be \fINULL\fR. @@ -49,12 +47,10 @@ not be \fINULL\fR. .sp .ne 2 -.mk .na \fB\fIppSrvURL\fR\fR .ad .RS 12n -.rt A pointer to a ponter for the \fBSLPSrvURL\fR structure to receive the parsed \fBURL\fR. It may not be \fINULL\fR. .RE @@ -85,12 +81,10 @@ err = SLPParseSrvURL("service:printer:lpr://serv/queue1", &surl); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPReg.3slp b/usr/src/man/man3slp/SLPReg.3slp index 0c0dd53a66..7fcba4570b 100644 --- a/usr/src/man/man3slp/SLPReg.3slp +++ b/usr/src/man/man3slp/SLPReg.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPReg 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPREG 3SLP "Jan 16, 2003" .SH NAME SLPReg \- register an SLP advertisement .SH SYNOPSIS @@ -45,36 +45,30 @@ obtained through configuration. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 14n -.rt The language specific \fBSLPHandle\fR on which to register the advertisement. \fIhSLP\fR cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcSrvURL\fR\fR .ad .RS 14n -.rt The \fBURL\fR to register. The value of \fIpcSrvURL\fR cannot be \fINULL\fR or the empty string. .RE .sp .ne 2 -.mk .na \fB\fIusLifetime\fR\fR .ad .RS 14n -.rt An \fBunsigned short\fR giving the life time of the service advertisement, in seconds. The value must be an unsigned integer less than or equal to \fBSLP_LIFETIME_MAXIMUM\fR. @@ -82,24 +76,20 @@ seconds. The value must be an unsigned integer less than or equal to .sp .ne 2 -.mk .na \fB\fIpcSrvType\fR\fR .ad .RS 14n -.rt The service type. If \fIpURL\fR is a service: URL, then this parameter is ignored. \fIpcSrvType\fR cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcAttrs\fR\fR .ad .RS 14n -.rt A comma-separated list of attribute assignment expressions for the attributes of the advertisement. \fIpcAttrs\fR cannot be \fINULL\fR. Use the empty string, \fB""\fR, to indicate no attributes. @@ -107,36 +97,30 @@ the empty string, \fB""\fR, to indicate no attributes. .sp .ne 2 -.mk .na \fB\fIfresh\fR\fR .ad .RS 14n -.rt An \fBSLPBoolean\fR that is \fBSLP_TRUE\fR if the registration is new or \fBSLP_FALSE\fR if it is a reregistration. .RE .sp .ne 2 -.mk .na \fB\fIcallback\fR\fR .ad .RS 14n -.rt A callback to report the operation completion status. \fIcallback\fR cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 14n -.rt Memory passed to the callback code from the client. \fIpvCookie\fR can be \fINULL\fR. .RE @@ -170,12 +154,10 @@ err = SLPReg(hSLP, "service:video://bldg15", .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPSetProperty.3slp b/usr/src/man/man3slp/SLPSetProperty.3slp index 91004922fa..223f2efae0 100644 --- a/usr/src/man/man3slp/SLPSetProperty.3slp +++ b/usr/src/man/man3slp/SLPSetProperty.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPSetProperty 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPSETPROPERTY 3SLP "Jan 16, 2003" .SH NAME SLPSetProperty \- set an SLP configuration property .SH SYNOPSIS @@ -24,24 +24,20 @@ string. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIpcName\fR\fR .ad .RS 11n -.rt A null-terminated string with the property name. \fIpcName\fR cannot be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIpcValue\fR\fR .ad .RS 11n -.rt A null-terminated string with the property value. \fIpcValue\fR cannot be \fINULL\fR .RE @@ -69,12 +65,10 @@ SLPSetProperty ("net.slp.typeHint" "service:ftp"); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/SLPUnescape.3slp b/usr/src/man/man3slp/SLPUnescape.3slp index a734f83a8e..71e2bd8b52 100644 --- a/usr/src/man/man3slp/SLPUnescape.3slp +++ b/usr/src/man/man3slp/SLPUnescape.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH SLPUnescape 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLPUNESCAPE 3SLP "Jan 16, 2003" .SH NAME SLPUnescape \- translate escaped characters into UTF-8 .SH SYNOPSIS @@ -30,23 +30,19 @@ longer needed. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIpcInBuf\fR\fR .ad .RS 13n -.rt Pointer to the input buffer to process for escape characters. .RE .sp .ne 2 -.mk .na \fB\fIppcOutBuf\fR\fR .ad .RS 13n -.rt Pointer to a pointer for the output buffer with the \fBSLP\fR reserved characters escaped. Must be freed using \fBSLPFree\fR(3SLP) when the memory is no longer needed. @@ -54,12 +50,10 @@ no longer needed. .sp .ne 2 -.mk .na \fB\fIisTag\fR\fR .ad .RS 13n -.rt When true, the input buffer is checked for bad tag characters. .RE @@ -88,12 +82,10 @@ err = SLPUnescape("\\2c tag\\2c", &pcOutbuf, SLP_TRUE); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE diff --git a/usr/src/man/man3slp/slp_api.3slp b/usr/src/man/man3slp/slp_api.3slp index ad8c281934..e60fb7b846 100644 --- a/usr/src/man/man3slp/slp_api.3slp +++ b/usr/src/man/man3slp/slp_api.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH slp_api 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLP_API 3SLP "Jan 16, 2003" .SH NAME slp_api \- Service Location Protocol Application Programming Interface .SH SYNOPSIS @@ -133,48 +133,40 @@ code passed to the callback has value \fBSLP_LAST_CALL\fR. There are four reasons why the call can terminate: .sp .ne 2 -.mk .na \fBDA reply received\fR .ad .RS 26n -.rt A reply from a \fBDA\fR has been received and therefore nothing more is expected. .RE .sp .ne 2 -.mk .na \fBMulticast terminated\fR .ad .RS 26n -.rt The multicast convergence time has elapsed and the \fBAPI\fR library multicast code is giving up. .RE .sp .ne 2 -.mk .na \fBMulticast null results\fR .ad .RS 26n -.rt Nothing new has been received during multicast for awhile and the \fBAPI\fR library multicast code is giving up on that (as an optimization). .RE .sp .ne 2 -.mk .na \fBMaximum results\fR .ad .RS 26n -.rt The user has set the \fBnet.slp.maxResults\fR property and that number of replies has been collected and returned. .RE @@ -246,47 +238,39 @@ function with information parsed from a character buffer containing a service follows: .sp .ne 2 -.mk .na \fB\fBs_pcSrvType\fR\fR .ad .RS 17n -.rt A pointer to a character string containing the service type name, including naming authority. .RE .sp .ne 2 -.mk .na \fB\fBs_pcHost\fR\fR .ad .RS 17n -.rt A pointer to a character string containing the host identification information. .RE .sp .ne 2 -.mk .na \fB\fBs_iPort\fR\fR .ad .RS 17n -.rt The port number, or zero, if none. The port is only available if the transport is \fBIP\fR. .RE .sp .ne 2 -.mk .na \fB\fBs_pcNetFamily\fR\fR .ad .RS 17n -.rt A pointer to a character string containing the network address family identifier. Possible values are "\fBipx\fR" for the \fBIPX\fR family, "\fBat\fR" for the Appletalk family, and \fB""\fR, the empty string, for the @@ -295,12 +279,10 @@ identifier. Possible values are "\fBipx\fR" for the \fBIPX\fR family, .sp .ne 2 -.mk .na \fB\fBs_pcSrvPart\fR\fR .ad .RS 17n -.rt The remainder of the \fBURL\fR, after the host identification. .sp The host and port should be sufficient to open a socket to the machine hosting @@ -348,8 +330,8 @@ operations ignore the return since the operation is already complete. .sp .in +2 .nf -typedef void SLPRegReport(SLPHandle hSLP, - SLPError errCode, +typedef void SLPRegReport(SLPHandle hSLP, + SLPError errCode, void *pvCookie); .fi .in -2 @@ -361,34 +343,28 @@ typedef void SLPRegReport(SLPHandle hSLP, callback has the following parameters: .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 12n -.rt The\fBSLPHandle()\fR used to initiate the operation. .RE .sp .ne 2 -.mk .na \fB\fIerrCode\fR\fR .ad .RS 12n -.rt An error code indicating if an error occurred during the operation. .RE .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 12n -.rt Memory passed down from the client code that called the original \fBAPI\fR function, starting the operation. It may be \fINULL\fR. .RE @@ -397,9 +373,9 @@ function, starting the operation. It may be \fINULL\fR. .sp .in +2 .nf -typedef SLPBoolean SLPSrvTypeCallback(SLPHandle hSLP, - const char* pcSrvTypes, - SLPError errCode, +typedef SLPBoolean SLPSrvTypeCallback(SLPHandle hSLP, + const char* pcSrvTypes, + SLPError errCode, void *pvCookie); .fi .in -2 @@ -412,35 +388,29 @@ when the \fIhSLP\fR handle is opened either synchronously or asynchronously. The \fBSLPSrvTypeCallback()\fR callback has the following parameters: .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 14n -.rt The \fBSLPHandle\fR used to initiate the operation. .RE .sp .ne 2 -.mk .na \fB\fIpcSrvTypes\fR\fR .ad .RS 14n -.rt A character buffer containing a comma-separated, null-terminated list of service types. .RE .sp .ne 2 -.mk .na \fB\fIerrCode\fR\fR .ad .RS 14n -.rt An error code indicating if an error occurred during the operation. The callback should check this error code before processing the parameters. If the error code is other than \fBSLP_OK\fR, then the \fBAPI\fR library may choose to @@ -449,12 +419,10 @@ terminate the outstanding operation. .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 14n -.rt emory passed down from the client code that called the original \fBAPI\fR function, starting the operation. It can be \fINULL\fR. .RE @@ -463,11 +431,11 @@ function, starting the operation. It can be \fINULL\fR. .sp .in +2 .nf -typedef SLPBoolean SLPSrvURLCallback(SLPHandle hSLP, - const char* pcSrvURL, - unsigned short usLifetime, - SLPError errCode, - void *pvCookie); +typedef SLPBoolean SLPSrvURLCallback(SLPHandle hSLP, + const char* pcSrvURL, + unsigned short usLifetime, + SLPError errCode, + void *pvCookie); .fi .in -2 @@ -479,46 +447,38 @@ regardless of whether the \fIhSLP\fR was opened collated or uncollated. The \fBSLPSrvURLCallback()\fR callback has the following parameters: .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 14n -.rt The \fBSLPHandle\fR used to initiate the operation. .RE .sp .ne 2 -.mk .na \fB\fIpcSrvURL\fR\fR .ad .RS 14n -.rt A character buffer containing the returned service \fBURL\fR. .RE .sp .ne 2 -.mk .na \fB\fIusLifetime\fR\fR .ad .RS 14n -.rt An unsigned short giving the life time of the service advertisement. The value must be an unsigned integer less than or equal to \fBSLP_LIFETIME_MAXIMUM\fR. .RE .sp .ne 2 -.mk .na \fB\fIerrCode\fR\fR .ad .RS 14n -.rt An error code indicating if an error occurred during the operation. The callback should check this error code before processing the parameters. If the error code is other than \fBSLP_OK\fR, then the \fBAPI\fR library may choose to @@ -527,12 +487,10 @@ terminate the outstanding operation. .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 14n -.rt Memory passed down from the client code that called the original \fBAPI\fR function, starting the operation. It can be \fINULL\fR. .RE @@ -541,9 +499,9 @@ function, starting the operation. It can be \fINULL\fR. .sp .in +2 .nf -typedef SLPBoolean SLPAttrCallback(SLPHandle hSLP, - const char* pcAttrList, - SLPError errCode, +typedef SLPBoolean SLPAttrCallback(SLPHandle hSLP, + const char* pcAttrList, + SLPError errCode, void *pvCookie); .fi .in -2 @@ -577,35 +535,29 @@ once, and the \fIpcAttrList\fR parameter is set to the collated result. \fBSLPAttrCallback()\fR callback has the following parameters: .sp .ne 2 -.mk .na \fB\fIhSLP\fR\fR .ad .RS 14n -.rt The \fBSLPHandle\fR used to initiate the operation. .RE .sp .ne 2 -.mk .na \fB\fIpcAttrList\fR\fR .ad .RS 14n -.rt A character buffer containing a comma-separated and null-terminated list of attribute id/value assignments, in \fBSLP\fR wire format. .RE .sp .ne 2 -.mk .na \fB\fIerrCode\fR\fR .ad .RS 14n -.rt An error code indicating if an error occurred during the operation. The callback should check this error code before processing the parameters. If the error code is other than \fBSLP_OK\fR, then the \fBAPI\fR library may choose to @@ -614,12 +566,10 @@ terminate the outstanding operation. .sp .ne 2 -.mk .na \fB\fIpvCookie\fR\fR .ad .RS 14n -.rt Memory passed down from the client code that called the original \fBAPI\fR function, starting the operation. It can be \fINULL\fR. .RE @@ -631,12 +581,10 @@ An interface that is part of the \fBSLP\fR \fBAPI\fR may return one of the following values. .sp .ne 2 -.mk .na \fB\fBSLP_LAST_CALL\fR\fR .ad .RS 30n -.rt The \fBSLP_LAST_CALL\fR code is passed to callback functions when the \fBAPI\fR library has no more data for them and therefore no further calls will be made to the callback on the currently outstanding operation. The callback uses this @@ -651,24 +599,20 @@ error parameter set to \fBSLP_LAST_CALL\fR. .sp .ne 2 -.mk .na \fB\fBSLP_OK\fR\fR .ad .RS 30n -.rt The \fBSLP_OK\fR code indicates that the no error occurred during the operation. .RE .sp .ne 2 -.mk .na \fB\fBSLP_LANGUAGE_NOT_SUPPORTED\fR\fR .ad .RS 30n -.rt No \fBDA\fR or \fBSA\fR has service advertisement information in the language requested, but at least one \fBDA\fR or \fBSA\fR might have information for that service in another language. @@ -676,12 +620,10 @@ that service in another language. .sp .ne 2 -.mk .na \fB\fBSLP_PARSE_ERROR\fR\fR .ad .RS 30n -.rt The \fBSLP\fR message was rejected by a remote \fBSLP\fR agent. The \fBAPI\fR returns this error only when no information was retrieved, and at least one \fBSA\fR or \fBDA\fR indicated a protocol error. The data supplied through the @@ -690,12 +632,10 @@ returns this error only when no information was retrieved, and at least one .sp .ne 2 -.mk .na \fB\fBSLP_INVALID_REGISTRATION\fR\fR .ad .RS 30n -.rt The \fBAPI\fR may return this error if an attempt to register a service was rejected by all \fBDA\fRs because of a malformed \fBURL\fR or attributes.\fBSLP\fR does not return the error if at least one \fBDA\fR accepts @@ -704,12 +644,10 @@ the registration. .sp .ne 2 -.mk .na \fB\fBSLP_SCOPE_NOT_SUPPORTED\fR\fR .ad .RS 30n -.rt The \fBAPI\fR returns this error if the \fBUA\fR or \fBSA\fR has been configured with the \fBnet.slp.useScopes\fR list of scopes and the \fBSA\fR request did not specify one or more of these allowable scopes, and no others. @@ -719,48 +657,40 @@ supported by a \fBDA\fR. .sp .ne 2 -.mk .na \fB\fBSLP_AUTHENTICATION_ABSENT\fR\fR .ad .RS 30n -.rt This error arises when the \fBUA\fR or \fBSA \fRfailed to send an authenticator for requests or registrations when security is enabled and thus required. .RE .sp .ne 2 -.mk .na \fB\fBSLP_AUTHENTICATION_FAILED\fR\fR .ad .RS 30n -.rt This error arises when a authentication on an \fBSLP\fR message received from a remote \fBSLP\fR agent failed. .RE .sp .ne 2 -.mk .na \fB\fBSLP_INVALID_UPDATE\fR\fR .ad .RS 30n -.rt An update for a nonexisting registration was issued, or the update includes a service type or scope different than that in the initial registration. .RE .sp .ne 2 -.mk .na \fB\fBSLP_REFRESH_REJECTED\fR\fR .ad .RS 30n -.rt The \fBSA\fR attempted to refresh a registration more frequently than the minimum refresh interval. The \fBSA\fR should call the appropriate \fBAPI\fR function to obtain the minimum refresh interval to use. @@ -768,106 +698,88 @@ function to obtain the minimum refresh interval to use. .sp .ne 2 -.mk .na \fB\fBSLP_NOT_IMPLEMENTED\fR\fR .ad .RS 30n -.rt An outgoing request overflowed the maximum network \fBMTU\fR size. The request should be reduced in size or broken into pieces and tried again. .RE .sp .ne 2 -.mk .na \fB\fBSLP_BUFFER_OVERFLOW\fR\fR .ad .RS 30n -.rt An outgoing request overflowed the maximum network \fBMTU\fR size. The request should be reduced in size or broken into pieces and tried again. .RE .sp .ne 2 -.mk .na \fB\fBSLP_NETWORK_TIMED_OUT\fR\fR .ad .RS 30n -.rt When no reply can be obtained in the time specified by the configured timeout interval, this error is returned. .RE .sp .ne 2 -.mk .na \fB\fBSLP_NETWORK_INIT_FAILED\fR\fR .ad .RS 30n -.rt If the network cannot initialize properly, this error is returned. .RE .sp .ne 2 -.mk .na \fB\fBSLP_MEMORY_ALLOC_FAILED\fR\fR .ad .RS 30n -.rt If the \fBAPI\fR fails to allocate memory, the operationis aborted and returns this. .RE .sp .ne 2 -.mk .na \fB\fBSLP_PARAMETER_BAD\fR\fR .ad .RS 30n -.rt If a parameter passed into an interface is bad, this error is returned. .RE .sp .ne 2 -.mk .na \fB\fBSLP_NETWORK_ERROR\fR\fR .ad .RS 30n -.rt The failure of networking during normal operations causes this error to be returned. .RE .sp .ne 2 -.mk .na \fB\fBSLP_INTERNAL_SYSTEM_ERROR\fR\fR .ad .RS 30n -.rt A basic failure of the \fBAPI\fR causes this error to be returned. This occurs when a system call or library fails. The operation could not recover. .RE .sp .ne 2 -.mk .na \fB\fBSLP_HANDLE_IN_USE\fR\fR .ad .RS 30n -.rt In the C \fBAPI\fR, callback functions are not permitted to recursively call into the \fBAPI\fR on the same \fBSLPHandle\fR, either directly or indirectly. If an attempt is made to do so, this error is returned from the called @@ -877,188 +789,154 @@ If an attempt is made to do so, this error is returned from the called .SH LIST OF ROUTINES .sp .ne 2 -.mk .na \fB\fBSLPOpen()\fR\fR .ad .RS 27n -.rt open an \fBSLP\fR handle .RE .sp .ne 2 -.mk .na \fB\fBSLPClose()\fR\fR .ad .RS 27n -.rt close an open \fBSLP\fR handle .RE .sp .ne 2 -.mk .na \fB\fBSLPReg()\fR\fR .ad .RS 27n -.rt register a service advertisement .RE .sp .ne 2 -.mk .na \fB\fBSLPDereg()\fR\fR .ad .RS 27n -.rt deregister a service advertisement .RE .sp .ne 2 -.mk .na \fB\fBSLPDelAttrs()\fR\fR .ad .RS 27n -.rt delete attributes .RE .sp .ne 2 -.mk .na \fB\fBSLPFindSrvTypes()\fR\fR .ad .RS 27n -.rt return service types .RE .sp .ne 2 -.mk .na \fB\fBSLPFindSrvs()\fR\fR .ad .RS 27n -.rt return service URLs .RE .sp .ne 2 -.mk .na \fB\fBSLPFindAttrs()\fR\fR .ad .RS 27n -.rt return service attributes .RE .sp .ne 2 -.mk .na \fB\fBSLPGetRefreshInterval()\fR\fR .ad .RS 27n -.rt return the maximum allowed refresh interval for \fBSA\fRs .RE .sp .ne 2 -.mk .na \fB\fBSLPFindScopes()\fR\fR .ad .RS 27n -.rt return list of configured and discovered scopes .RE .sp .ne 2 -.mk .na \fB\fBSLPParseSrvURL()\fR\fR .ad .RS 27n -.rt parse service \fBURL\fR .RE .sp .ne 2 -.mk .na \fB\fBSLPEscape()\fR\fR .ad .RS 27n -.rt escape special characters .RE .sp .ne 2 -.mk .na \fB\fBSLPUnescape()\fR\fR .ad .RS 27n -.rt translate escaped characters into \fBUTF-8\fR .RE .sp .ne 2 -.mk .na \fB\fBSLPGetProperty()\fR\fR .ad .RS 27n -.rt return \fBSLP\fR configuration property .RE .sp .ne 2 -.mk .na \fB\fBSLPSetProperty()\fR\fR .ad .RS 27n -.rt set an \fBSLP\fR configuration property .RE .sp .ne 2 -.mk .na \fB\fBslp_strerror()\fR\fR .ad .RS 27n -.rt map \fBSLP\fR error code to message .RE .sp .ne 2 -.mk .na \fB\fBSLPFree()\fR\fR .ad .RS 27n -.rt free memory .RE @@ -1074,15 +952,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -CSICSI-enabled +CSI CSI-enabled _ -MT-LevelSafe +MT-Level Safe .TE .SH SEE ALSO diff --git a/usr/src/man/man3slp/slp_strerror.3slp b/usr/src/man/man3slp/slp_strerror.3slp index 6f3d5fd7bf..85ed9b48c9 100644 --- a/usr/src/man/man3slp/slp_strerror.3slp +++ b/usr/src/man/man3slp/slp_strerror.3slp @@ -3,7 +3,7 @@ .\" 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] -.TH slp_strerror 3SLP "16 Jan 2003" "SunOS 5.11" "Service Location Protocol Library Functions" +.TH SLP_STRERROR 3SLP "Jan 16, 2003" .SH NAME slp_strerror \- map SLP error codes to messages .SH SYNOPSIS @@ -23,12 +23,10 @@ freed. .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIerr_code\fR\fR .ad .RS 12n -.rt An \fBSLP\fR error code. .RE @@ -56,12 +54,10 @@ msg = slp_streerror(err); .SH ENVIRONMENT VARIABLES .sp .ne 2 -.mk .na \fB\fBSLP_CONF_FILE\fR\fR .ad .RS 17n -.rt When set, use this file for configuration. .RE |
