SIP_ADD_HEADER(3SIP) Session Initiation Protocol Library Functions

NAME

sip_add_header - add a SIP header to the SIP message

SYNOPSIS

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

int sip_add_header(sip_msg_t sip_msg, char *header_string);

DESCRIPTION

The sip_add_header() function takes the SIP header header_string,
adds a CRLF (carriage return/line feed) and appends it to the SIP
message sip_msg. The sip_add_header() function is typically used when
adding a SIP header with multiple values.

RETURN VALUES

The sip_add_header() function returns 0 on success and the
appropriate error value on failure.

ERRORS

On failure, the sip_add_header() function can return one of the
following error values:

EINVAL
Mandatory parameters are not provided, i.e. null.


EPERM
The message cannot be modified.


ENOMEM
Error allocating memory for creating headers/parameters.

ATTRIBUTES

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


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+

SEE ALSO

libsip(3LIB)

February 9, 2007 SIP_ADD_HEADER(3SIP)