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_header 3SIP "09 Feb 2007" "SunOS 5.11" "Session Initiation Protocol Library Functions"
 NAME
sip_get_header - get a SIP header from a message

 SYNOPSIS


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

const struct sip_header *sip_get_header(sip_msg_t sip_msg, 
 char *header_name, sip_header_t old_header, int *error);




 DESCRIPTION

The sip_get_header() function returns the header specified by
header_name (long or compact form) from the SIP message
sip_msg. If header_name is NULL, the first header in the
SIP message is returned. The old_header, if non-null, specifies the
starting position in sip_msg from which the search is started. Otherwise,
the search begins at the start of the SIP message. For example, to get
the first VIA header from the SIP message sip_msg:

via_hdr = sip_get_header(sip_msg, "VIA", NULL, &error);





To get the next VIA header from sip_msg:

via_hdr = sip_get_header(sip_msg, "VIA", via_hdr, &error);





The sip_get_header() function ignores any header that is marked as
deleted.

 RETURN VALUES

On success, the sip_get_header() function returns the queried header. On
failure, it returns NULL.


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

 ERRORS

The following value may be returned:


EINVAL


The header_name specified in the SIP message is not present or has
been deleted; or, the header_name is not specified and there are no
"un-deleted" headers in the SIP message.




 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityCommitted
MT-LevelMT-Safe



 SEE ALSO

libsip(3LIB)