Content-type: text/html Man page of sip_get_request_uri_str

sip_get_request_uri_str

Section: Session Initiation Protocol Library Functions (3SIP)
Updated: 20 Mar 2007
Index Return to Main Contents
 

NAME

sip_get_request_uri_str - return request URI  

SYNOPSIS

cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>

const sip_str_t *sip_get_request_uri_str(sip_msg_t sip_msg, 
    int *error);

 

DESCRIPTION

For functions that return a pointer of type sip_str_t, sip_str_t is supplied by:

typedef struct sip_str {
    char *sip_str_ptr;
    int  sip_str_len;
}sip_str_t;

The sip_str_ptr parameter points to the start of the returned value and sip_str_len supplies the length of the returned value.

For example, given the following request line in a SIP message input to sip_get_request_uri_str():

INVITE sip:[email protected] SIP/2.0

the return is a pointer to sip_str_t with the sip_str_ptr member pointing to "s" of sip:[email protected] and sip_str_len being set to 21, the length of sip:[email protected].

The sip_get_request_uri_str() function returns the URI string from the request line in the SIP message sip_msg.  

RETURN VALUES

The sip_get_request_uri_str() function returns the URI string. The function returns NULL on failure.

The value of errno is not changed by these calls in the event of an error.  

ERRORS

If the error is non-null, one of the following values is set:

EINVAL

For the sip_get_request_uri_str() function, there is no request line is in the SIP message.

EPROTO

For sip_get_request_uri_str, the request URI is invalid.

On success, the value of the location pointed to by error is set to 0.  

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE

Interface StabilityStable

MT-Level

 

SEE ALSO

libsip(3SIP)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUES
ERRORS
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:37:50 GMT, October 02, 2010