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_branchid_to_via 3SIP "25 Jan 2007" "SunOS 5.11" "Session Initiation Protocol Library Functions"
 NAME
sip_add_branchid_to_via - add a branch parameter to the topmost VIA header in
the SIP message

 SYNOPSIS


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

int sip_add_branchid_to_via(sip_msg_t sip_msg, char *branchid);




 DESCRIPTION

The sip_add_branchid_to_via() function adds a branch param to the
topmost VIA header in the SIP message sip_msg. Note that a
new header is created as a result of adding the branch parameter and the old
header is marked deleted. Applications with multiple threads working on the
same VIA header need to take note of this.

 RETURN VALUES

These functions return 0 on success 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 or are NULL.
For sip_add_branchid_to_via(), the topmost VIA header already has a
branch param or the SIP message does not have a VIA header.





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:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityCommitted
MT-LevelMT-Safe



 SEE ALSO

libsip(3LIB)