share/man/man3sip/sip_delete_start_line.3sip

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SIP_DELETE_START_LINE 3SIP "Jan 20, 2007"
   7 .SH NAME
   8 sip_delete_start_line, sip_delete_header, sip_delete_header_by_name,
   9 sip_delete_value \- delete a SIP header or a header value
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  14 #include <sip.h>
  15
  16 \fBint\fR \fIsip_delete_start_line\fR(\fBsip_msg_t\fR \fIsip_msg\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fIsip_delete_header\fR(\fBsip_msg_t\fR \fIsip_header\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBint\fR \fIsip_delete_header_by_name\fR(\fBsip_msg_t\fR \fImsg\fR,
  27      \fBchar *\fR\fIheader_name\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBint\fR \fIsip_delete_value\fR(\fBsip_header_t\fR \fIsip_header\fR,
  33      \fBsip_header_value_t\fR \fIsip_header_value\fR);
  34 .fi
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 The \fBsip_delete_start_line()\fR function deletes the start line, a request or
  40 a response line, from the SIP message \fIsip_msg\fR.
  41 .sp
  42 .LP
  43 The \fBsip_delete_header()\fR function deletes the \fBSIP\fR header specified
  44 by \fIsip_header\fR from the associated \fBSIP\fR message \fIsip_msg\fR.
  45 .sp
  46 .LP
  47 The \fBsip_delete_header_by_name()\fR function deletes the \fBSIP\fR header
  48 name specified by \fIheader_name\fR (long or compact form) from the \fBSIP\fR
  49 message \fIsip_msg\fR.
  50 .sp
  51 .LP
  52 The \fBsip_delete_value()\fR deletes the \fBSIP\fR header value specified by
  53 \fIsip_header_value\fR from the \fBSIP\fR header \fIsip_header\fR.
  54 .sp
  55 .LP
  56 When a \fBSIP\fR header or value is deleted, the corresponding header or value
  57 is marked as deleted.  Lookups ignore headers or values that are marked as
  58 deleted.
  59 .SH RETURN VALUES
  60 .sp
  61 .LP
  62 These functions return \fB0\fR on success and the appropriate error on failure.
  63 .sp
  64 .LP
  65 The value of \fBerrno\fR is not changed by these calls in the event of an
  66 error.
  67 .SH ERRORS
  68 .sp
  69 .LP
  70 On failure, the returned error could be one of the following:
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBEINVAL\fR\fR
  75 .ad
  76 .RS 10n
  77 If any of the required input is \fBNULL\fR.
  78 .sp
  79 If the header or value to be deleted does not exist.
  80 .sp
  81 If the header or value to be deleted has already been deleted.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBEPERM\fR\fR
  88 .ad
  89 .RS 10n
  90 If the \fBSIP\fR message cannot be modified.
  91 .RE
  92
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 Interface Stability     Committed
 107 _
 108 MT-Level        MT-Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBlibsip\fR(3LIB)