Current File : //usr/share/man/man3sip/sip_add_header.3sip

'\" te
.\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
.TH sip_add_header 3SIP "09 Feb 2007" "SunOS 5.11" "Session Initiation Protocol Library Functions"
.SH NAME
sip_add_header \- add a SIP header to the SIP message
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
#include <sip.h>

\fBint\fR \fIsip_add_header\fR(\fBsip_msg_t\fR \fIsip_msg\fR, \fBchar *\fR\fIheader_string\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBsip_add_header()\fR function takes the \fBSIP\fR header \fIheader_string\fR, adds a \fBCRLF\fR (carriage return/line feed) and appends it to the \fBSIP\fR message \fIsip_msg\fR. The \fBsip_add_header()\fR function is typically used when adding a \fBSIP\fR header with multiple values.
.SH RETURN VALUES
.sp
.LP
The \fBsip_add_header()\fR function returns \fB0\fR on success and the appropriate error value on failure.
.SH ERRORS
.sp
.LP
On failure, the \fBsip_add_header()\fR function can return one of the following error values:
.sp
.ne 2
.mk
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
.rt  
Mandatory parameters are not provided, i.e. null.
.RE

.sp
.ne 2
.mk
.na
\fB\fBEPERM\fR\fR
.ad
.RS 10n
.rt  
The message cannot be modified.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENOMEM\fR\fR
.ad
.RS 10n
.rt  
Error allocating memory for creating headers/parameters.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBlibsip\fR(3LIB)