sip_add_param

- add a parameter to the SIP header

Synopsis

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

sip_header_t sip_add_param(sip_header_t sip_header, char *param, 
     int *error);

Description

The sip_add_param() function adds the parameter provided in param to the SIP header sip_header. The function returns the header with the parameter added. A new header is created as a result of adding the parameter and the old header is marked deleted. Applications with multiple threads working on the same SIP header need to take note of this. If error is non-null, it (the location pointer by the variable) is set to 0 on success and the appropriate error value on error.

Return Values

The sip_add_param() function returns the new header on success and null on failure. Further, if error is non-null, then on success the value in the location pointed by error is 0 and the appropriate error value on failure.

Errors

On failure, functions that return an error value may return one of the following:

EINVAL

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

For sip_add_param(), the header to be modified is marked deleted.

EPERM

The message cannot be modified.

ENOMEM

There is an error allocating memory for creating headers/parameters.

Attributes

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

See Also

libsip(3LIB)