usr/src/man/man3sip/sip_get_msg_len.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_GET_MSG_LEN 3SIP "Feb 09, 2007"
   7 .SH NAME
   8 sip_get_msg_len \- returns the length of the SIP message
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  13 #include <sip.h>
  14
  15 \fBint\fR \fIsip_get_msg_len\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  16      \fBint *\fR\fIerror\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBsip_get_msg_len()\fR function will return the length of the \fBSIP\fR
  23 message \fIsip_msg\fR.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 For functions that return an integer, the return value is the specified value
  28 on success and \fB-1\fR on error.
  29 .sp
  30 .LP
  31 The value of \fBerrno\fR is not changed by these calls in the event of an
  32 error.
  33 .SH ERRORS
  34 .sp
  35 .LP
  36 This function takes a pointer to an integer \fIerror\fR as an argument. If the
  37 error is non-null, one of the following values is set:
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBEINVAL\fR\fR
  42 .ad
  43 .RS 10n
  44 The input \fBSIP\fR message \fIsip_msg\fR or the header value is null; or the
  45 specified header/header value is deleted.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBEPROTO\fR\fR
  52 .ad
  53 .RS 10n
  54 The header value is not present or invalid. The parser could not parse it
  55 correctly.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBENOMEM\fR\fR
  62 .ad
  63 .RS 10n
  64 There is an error allocating memory for the return value.
  65 .RE
  66
  67 .sp
  68 .LP
  69 On success, the value of the location pointed to by \fIerror\fR is set to
  70 \fB0\fR.
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 Interface Stability     Committed
  85 _
  86 MT-Level        MT-Safe
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBlibsip\fR(3LIB)