share/man/man3sip/sip_get_num_via.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_NUM_VIA 3SIP "Jan 23, 2007"
   7 .SH NAME
   8 sip_get_num_via, sip_get_branchid \- get VIA header specific attributes
   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_num_via\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  16      \fBint *\fR\fIerror\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBchar *\fR\fIsip_get_branchid\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  22      \fBint *\fR\fIerror\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBsip_get_num_via()\fR function returns the number of \fBVIA\fR headers in
  29 the \fBSIP\fR message \fIsip_msg\fR.
  30 .sp
  31 .LP
  32 The \fBsip_get_branchid()\fR function returns the branch ID value from the
  33 topmost \fBVIA\fR header. The caller is responsible for freeing the returned
  34 string.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 The \fBsip_get_num_via()\fR function returns the number of \fBVIA\fR headers on
  39 success.
  40 .sp
  41 .LP
  42 The \fBsip_get_branchid()\fR function returns the branch ID on success and
  43 \fBNULL\fR on failure.
  44 .sp
  45 .LP
  46 The value of \fBerrno\fR is not changed by these calls in the event of an
  47 error.
  48 .SH ERRORS
  49 .sp
  50 .LP
  51 If the error is non-null, one of the following values is set:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBEINVAL\fR\fR
  56 .ad
  57 .RS 10n
  58 The \fIsip_msg\fR is \fBNULL\fR.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBENOENT\fR\fR
  65 .ad
  66 .RS 10n
  67 For the \fIsip_get_branchid\fR function, there is no \fBVIA\fR header or the
  68 \fBVIA\fR header has no branch parameter.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBEPROTO\fR\fR
  75 .ad
  76 .RS 10n
  77 For the \fIsip_sip_get_trans.3sipget_branchid\fR function, the \fBVIA\fR value
  78 is invalid. The parser encountered an error or errors while parsing the
  79 \fBVIA\fR header.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBENOMEM\fR\fR
  86 .ad
  87 .RS 10n
  88 For the \fIsip_get_branchid\fR function, there is an error in allocating memory
  89 for the branch ID.
  90 .RE
  91
  92 .sp
  93 .LP
  94 On success, the value of the location pointed to by \fIerror\fR is set to
  95 \fB0\fR.
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 Interface Stability     Committed
 110 _
 111 MT-Level        MT-Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBlibsip\fR(3LIB)