1sip_get_request_urSie_ssstiro(n3SIInPi)tiation Protocol Librasriyp_Fguentc_trieoqnusest_uri_str(3SIP)
2
3
4

NAME

6       sip_get_request_uri_str - return request URI
7

SYNOPSIS

9       cc [ flag ... ] file ... -lsip [ library ... ]
10       #include <sip.h>
11
12       const sip_str_t *sip_get_request_uri_str(sip_msg_t sip_msg,
13            int *error);
14
15

DESCRIPTION

17       For  functions  that  return  a pointer of type sip_str_t, sip_str_t is
18       supplied by:
19
20         typedef struct sip_str {
21              char *sip_str_ptr;
22              int  sip_str_len;
23         }sip_str_t;
24
25
26
27       The sip_str_ptr parameter points to the start of the returned value and
28       sip_str_len supplies the length of the returned value.
29
30
31       For example, given the following request line in a SIP message input to
32       sip_get_request_uri_str():
33
34         INVITE sip:marconi@radio.org SIP/2.0
35
36
37
38       the return is a pointer to sip_str_t with the sip_str_ptr member point‐
39       ing  to  "s"  of sip:marconi@radio.org and sip_str_len being set to 21,
40       the length of sip:marconi@radio.org.
41
42
43       The sip_get_request_uri_str() function returns the URI string from  the
44       request line in the SIP message sip_msg.
45

RETURN VALUES

47       The  sip_get_request_uri_str()  function  returns  the  URI string. The
48       function returns NULL on failure.
49
50
51       The value of errno is not changed by these calls in  the  event  of  an
52       error.
53

ERRORS

55       If the error is non-null, one of the following values is set:
56
57       EINVAL    For  the  sip_get_request_uri_str()  function,  there  is  no
58                 request line is in the SIP message.
59
60
61       EPROTO    For sip_get_request_uri_str, the request URI is invalid.
62
63
64
65       On success, the value of the location pointed to by error is set to 0.
66

ATTRIBUTES

68       See attributes(5) for descriptions of the following attributes:
69
70
71
72
73       ┌─────────────────────────────┬─────────────────────────────┐
74       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
75       ├─────────────────────────────┼─────────────────────────────┤
76       │Interface Stability          │Committed                    │
77       ├─────────────────────────────┼─────────────────────────────┤
78       │MT-Level                     │MT-Safe                      │
79       └─────────────────────────────┴─────────────────────────────┘
80

SEE ALSO

82       libsip(3LIB)
83
84
85
86SunOS 5.11                        25 Jan 2007    sip_get_request_uri_str(3SIP)
Impressum