SIP_GET_MSG_LEN(3SIP) Session Initiation Protocol Library Functions

NAME

sip_get_msg_len - returns the length of the SIP message

SYNOPSIS

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

int sip_get_msg_len(sip_msg_t sip_msg,
int *error);

DESCRIPTION

The sip_get_msg_len() function will return the length of the SIP
message sip_msg.

RETURN VALUES

For functions that return an integer, the return value is the
specified value on success and -1 on error.


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

ERRORS

This function takes a pointer to an integer error as an argument. If
the error is non-null, one of the following values is set:

EINVAL
The input SIP message sip_msg or the header value is null;
or the specified header/header value is deleted.


EPROTO
The header value is not present or invalid. The parser
could not parse it correctly.


ENOMEM
There is an error allocating memory for the return value.


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

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_GET_MSG_LEN(3SIP)