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]
cc [ flag ... ] file ... -lsip [ library ... ] #include <sip.h> int sip_delete_start_line(sip_msg_t sip_msg);
int sip_delete_header(sip_msg_t sip_header);
int sip_delete_header_by_name(sip_msg_t msg, char *header_name);
int sip_delete_value(sip_header_t sip_header, sip_header_value_t sip_header_value);
The sip_delete_start_line() function deletes the start line, a request or a response line, from the SIP message sip_msg.
The sip_delete_header() function deletes the SIP header specified by sip_header from the associated SIP message sip_msg.
The sip_delete_header_by_name() function deletes the SIP header name specified by header_name (long or compact form) from the SIP message sip_msg.
The sip_delete_value() deletes the SIP header value specified by sip_header_value from the SIP header sip_header.
When a SIP header or value is deleted, the corresponding header or value is marked as deleted. Lookups ignore headers or values that are marked as deleted.
These functions return 0 on success and the appropriate error on failure.
The value of errno is not changed by these calls in the event of an error.
On failure, the returned error could be one of the following: EINVAL
If any of the required input is NULL. If the header or value to be deleted does not exist. If the header or value to be deleted has already been deleted.
If the SIP message cannot be modified.
See attributes(7) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Committed |
| MT-Level MT-Safe |
libsip (3LIB)