xref: /illumos-gate/usr/src/man/man3sip/sip_get_msg_len.3sip (revision 7bb0eb348e1119aed76a61d633a9106b6b9912f1)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SIP_GET_MSG_LEN 3SIP "Feb 09, 2007"
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)