xref: /illumos-gate/usr/src/man/man3sip/sip_add_header.3sip (revision fc910014e8a32a65612105835a10995f2c13d942)
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_ADD_HEADER 3SIP "Feb 09, 2007"
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)