Content-type: text/html Man page of sip_get_num_via

sip_get_num_via

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

NAME

sip_get_num_via, sip_get_branchid - get VIA header specific attributes  

SYNOPSIS

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

int sip_get_num_via(sip_msg_t sip_msg, 
    int *error);

char *sip_get_branchid(sip_msg_t sip_msg, 
    int *error);

 

DESCRIPTION

The sip_get_num_via() function returns the number of VIA headers in the SIP message sip_msg.

The sip_get_branchid() function returns the branch ID value from the topmost VIA header. The caller is responsible for freeing the returned string.  

RETURN VALUES

The sip_get_num_via() function returns the number of VIA headers on success.

The sip_get_branchid() function returns the branch ID on success and 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

The sip_msg is NULL.

ENOENT

For the sip_get_branchid function, there is no VIA header or the VIA header has no branch parameter.

EPROTO

For the sip_sip_get_trans.3sipget_branchid function, the VIA value is invalid. The parser encountered an error or errors while parsing the VIA header.

ENOMEM

For the sip_get_branchid function, there is an error in allocating memory for the branch ID.

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:49 GMT, October 02, 2010