File: Ns_Url.3

package info (click to toggle)
aolserver4 4.5.1-15.1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 11,772 kB
  • sloc: ansic: 45,120; tcl: 5,532; sh: 1,021; makefile: 380; pascal: 219; php: 13
file content (89 lines) | stat: -rw-r--r-- 3,124 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

'\"
'\" The contents of this file are subject to the AOLserver Public License
'\" Version 1.1 (the "License"); you may not use this file except in
'\" compliance with the License. You may obtain a copy of the License at
'\" http://aolserver.com/.
'\"
'\" Software distributed under the License is distributed on an "AS IS"
'\" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
'\" the License for the specific language governing rights and limitations
'\" under the License.
'\"
'\" The Original Code is AOLserver Code and related documentation
'\" distributed by AOL.
'\" 
'\" The Initial Developer of the Original Code is America Online,
'\" Inc. Portions created by AOL are Copyright (C) 1999 America Online,
'\" Inc. All Rights Reserved.
'\"
'\" Alternatively, the contents of this file may be used under the terms
'\" of the GNU General Public License (the "GPL"), in which case the
'\" provisions of GPL are applicable instead of those above.  If you wish
'\" to allow use of your version of this file only under the terms of the
'\" GPL and not to allow others to use your version of this file under the
'\" License, indicate your decision by deleting the provisions above and
'\" replace them with the notice and other provisions required by the GPL.
'\" If you do not delete the provisions above, a recipient may use your
'\" version of this file under either the License or the GPL.
'\" 
'\"
'\" $Header: /cvsroot/aolserver/aolserver/doc/Ns_Url.3,v 1.4 2003/04/10 22:01:07 shmooved Exp $
'\"
'\" 
.so man.macros

.TH Ns_Url 3 4.0 AOLserver "AOLserver Library Procedures"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
Ns_AbsoluteUrl, Ns_ParseUrl, Ns_RelativeUrl, Ns_SkipUrl \- URL manipulation routines
.SH SYNOPSIS
.nf
\fB#include "ns.h"\fR
.sp
int
\fBNs_AbsoluteUrl\fR(\fINs_DString *pds, char *url, char *baseurl\fR)
.sp
int
\fBNs_ParseUrl\fR(\fIchar *url, char **pprotocol, char **phost,
            char **pport, char **ppath, char **ptail\fR)
.sp
char *
\fBNs_RelativeUrl\fR(\fIchar *url, char *location\fR)
.sp
char *
\fBNs_SkipUrl\fR(\fINs_Request *request, int n\fR)
.BE

.SH DESCRIPTION
.TP
\fBNs_AbsoluteUrl\fR(\fIpds, url, baseurl\fR)

Construct an URL based on baseurl but with as many parts of 
the incomplete url as possible. Return NS_OK or NS_ERROR.
.TP
\fBNs_ParseUrl\fR(\fIurl, pprotocol, phost, pport, ppath, ptail\fR)

Parse a URL into its component parts. Pointers to the protocol, 
host, port, path, and "tail" (last path element) will be set 
by reference in the passed-in pointers. The passed-in url will
be modified.
.TP
\fBNs_RelativeUrl\fR(\fIurl, location\fR)

If the url passed in is for this server, then the initial 
part of the URL is stripped off. e.g., on a server whose 
location is http://www.foo.com, Ns_RelativeUrl of 
"http://www.foo.com/hello" will return "/hello". 
Returns a pointer to the beginning of the relative url in the 
passed-in url, or NULL if error. Will set errno on error.
.TP
\fBNs_SkipUrl\fR(\fIrequest, n\fR)

Return a pointer n elements into the request's url.
.SH "SEE ALSO"
nsd(1), info(n)

.SH KEYWORDS