share/man/man3sip/sip_get_contact_display_name.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_CONTACT_DISPLAY_NAME 3SIP "Feb 10, 2007"
   7 .SH NAME
   8 sip_get_contact_display_name, sip_get_from_display_name,
   9 sip_get_to_display_name, sip_get_from_tag, sip_get_to_tag, sip_get_callid,
  10 sip_get_callseq_num, sip_get_callseq_method, sip_get_via_sent_by_host,
  11 sip_get_via_sent_by_port, sip_get_via_sent_protocol_version,
  12 sip_get_via_sent_protocol_name, sip_get_via_sent_transport, sip_get_maxforward,
  13 sip_get_content_length, sip_get_content_type, sip_get_content_sub_type,
  14 sip_get_content, sip_get_accept_type, sip_get_accept_sub_type,
  15 sip_get_accept_enc, sip_get_accept_lang, sip_get_alert_info_uri,
  16 sip_get_allow_method, sip_get_min_expires, sip_get_mime_version, sip_get_org,
  17 sip_get_priority, sip_get_replyto_display_name, sip_get_replyto_uri_str,
  18 sip_get_date_time, sip_get_date_day, sip_get_date_month, sip_get_date_wkday,
  19 sip_get_date_year, sip_get_date_timezone, sip_get_content_disp,
  20 sip_get_content_enc, sip_get_error_info_uri, sip_get_expires, sip_get_require,
  21 sip_get_subject, sip_get_supported, sip_get_tstamp_delay, sip_get_unsupported,
  22 sip_get_server, sip_get_user_agent, sip_get_warning_code,
  23 sip_get_warning_agent, sip_get_warning_text, sip_get_call_info_uri,
  24 sip_get_in_reply_to, sip_get_retry_after_time, sip_get_retry_after_cmts,
  25 sip_get_rack_resp_num, sip_get_rack_cseq_num, sip_get_rack_method,
  26 sip_get_rseq_resp_num, sip_get_priv_value, sip_get_passertedid_display_name,
  27 sip_get_passertedid_uri_str, sip_get_ppreferredid_display_name,
  28 sip_get_ppreferredid_uri_str, sip_get_author_scheme, sip_get_author_param,
  29 sip_get_authen_info, sip_get_proxy_authen_scheme, sip_get_proxy_authen_param,
  30 sip_get_proxy_author_scheme, sip_get_proxy_author_param, sip_get_proxy_require,
  31 sip_get_www_authen_scheme, sip_get_www_authen_param, sip_get_allow_events,
  32 sip_get_event, sip_get_substate, sip_get_content_lang, sip_get_tstamp_value,
  33 sip_get_route_uri_str, sip_get_route_display_name, sip_get_contact_uri_str,
  34 sip_get_from_uri_str, sip_get_to_uri_str \- obtain header specific attributes
  35 .SH SYNOPSIS
  36 .LP
  37 .nf
  38 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  39 #include <sip.h>
  40
  41 \fBconst sip_str_t *\fR\fIsip_get_contact_display_name\fR(\fBsip_header_value_t\fR \fIvalue\fR,
  42      \fBint *\fR\fIerror\fR);
  43 .fi
  44
  45 .LP
  46 .nf
  47 \fBconst sip_str_t *\fR\fIsip_get_from_display_name\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  48      \fBint *\fR\fIerror\fR);
  49 .fi
  50
  51 .LP
  52 .nf
  53 \fBconst sip_str_t *\fR\fIsip_get_to_display_name\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  54      \fBint *\fR\fIerror\fR);
  55 .fi
  56
  57 .LP
  58 .nf
  59 \fBconst sip_str_t *\fR\fIsip_get_contact_uri_str\fR(\fBsip_header_value_t\fR \fIvalue\fR,
  60      \fBint *\fR\fIerror\fR);
  61 .fi
  62
  63 .LP
  64 .nf
  65 \fBconst sip_str_t *\fR\fIsip_get_from_uri_str\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  66      \fBint *\fR\fIerror\fR);
  67 .fi
  68
  69 .LP
  70 .nf
  71 \fBconst sip_str_t *\fR\fIsip_get_to_uri_str\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  72      \fBint *\fR\fIerror\fR);
  73 .fi
  74
  75 .LP
  76 .nf
  77 \fBconst sip_str_t *\fR\fIsip_get_from_tag\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  78      \fBint *\fR\fIerror\fR);
  79 .fi
  80
  81 .LP
  82 .nf
  83 \fBconst sip_str_t *\fR\fIsip_get_to_tag\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  84      \fBint *\fR\fIerror\fR);
  85 .fi
  86
  87 .LP
  88 .nf
  89 \fBconst sip_str_t *\fR\fIsip_get_callid\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  90      \fBint *\fR\fIerror\fR);
  91 .fi
  92
  93 .LP
  94 .nf
  95 \fBint\fR \fIsip_get_callseq_num\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  96      \fBint *\fR\fIerror\fR);
  97 .fi
  98
  99 .LP
 100 .nf
 101 \fBsip_method_t\fR \fIsip_get_callseq_method\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 102      \fBint *\fR\fIerror\fR);
 103 .fi
 104
 105 .LP
 106 .nf
 107 \fBconst sip_str_t *\fR\fIsip_get_via_sent_by_host\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 108      \fBint *\fR\fIerror\fR);
 109 .fi
 110
 111 .LP
 112 .nf
 113 \fBint\fR \fIsip_get_via_sent_by_port\fR (\fBsip_header_value_t\fR \fIvalue\fR,
 114      \fBint *\fR\fIerror\fR);
 115 .fi
 116
 117 .LP
 118 .nf
 119 \fBconst sip_str_t *\fR\fIsip_get_via_sent_protocol_version\fR
 120      (\fBsip_header_value_t\fR \fIvalue\fR, \fBint *\fR\fIerror\fR);
 121 .fi
 122
 123 .LP
 124 .nf
 125 \fBconst sip_str_t *\fR\fIsip_get_via_sent_transport\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 126      \fBint *\fR\fIerror\fR);
 127 .fi
 128
 129 .LP
 130 .nf
 131 \fBint\fR \fIsip_get_maxforward\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 132      \fBint *\fR\fIerror\fR);
 133 .fi
 134
 135 .LP
 136 .nf
 137 \fBint\fR \fIsip_get_content_length\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 138      \fBint *\fR\fIerror\fR);
 139 .fi
 140
 141 .LP
 142 .nf
 143 \fBconst sip_str_t *\fR\fIsip_get_content_type\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 144      \fBint *\fR\fIerror\fR);
 145 .fi
 146
 147 .LP
 148 .nf
 149 \fBconst sip_str_t *\fR\fIsip_get_content_sub_type\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 150      \fBint *\fR\fIerror\fR);
 151 .fi
 152
 153 .LP
 154 .nf
 155 \fBchar *\fR\fIsip_get_content\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 156      \fBint *\fR\fIerror\fR);
 157 .fi
 158
 159 .LP
 160 .nf
 161 \fBconst sip_str_t *\fR\fIsip_get_accept_type\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 162      \fBint *\fR\fIerror\fR);
 163 .fi
 164
 165 .LP
 166 .nf
 167 \fBconst sip_str_t *\fR\fIsip_get_accept_sub_type\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 168      \fBint *\fR\fIerror\fR);
 169 .fi
 170
 171 .LP
 172 .nf
 173 \fBconst sip_str_t *\fR\fIsip_get_accept_enc\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 174      \fBint *\fR\fIerror\fR);
 175 .fi
 176
 177 .LP
 178 .nf
 179 \fBconst sip_str_t *\fR\fIsip_get_accept_lang\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 180      \fBint *\fR\fIerror\fR);
 181 .fi
 182
 183 .LP
 184 .nf
 185 \fBconst sip_str_t *\fR\fIsip_get_alert_info_uri\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 186      \fBint *\fR\fIerror\fR);
 187 .fi
 188
 189 .LP
 190 .nf
 191 \fBsip_method_t\fR \fIsip_get_allow_method\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 192      \fBint *\fR\fIerror\fR);
 193 .fi
 194
 195 .LP
 196 .nf
 197 \fBint\fR \fIsip_get_min_expire\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 198      \fBint *\fR\fIerror\fR);
 199 .fi
 200
 201 .LP
 202 .nf
 203 \fBconst sip_str_t *\fR\fIsip_get_mime_version\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 204      \fBint *\fR\fIerror\fR);
 205 .fi
 206
 207 .LP
 208 .nf
 209 \fBconst sip_str_t *\fR\fIsip_get_org\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 210      \fBint *\fR\fIerror\fR);
 211 .fi
 212
 213 .LP
 214 .nf
 215 \fBconst sip_str_t *\fR\fIsip_get_priority\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 216      \fBint *\fR\fIerror\fR);
 217 .fi
 218
 219 .LP
 220 .nf
 221 \fBconst sip_str_t *\fR\fIsip_get_replyto_display_name\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 222      \fBint *\fR\fIerror\fR);
 223 .fi
 224
 225 .LP
 226 .nf
 227 \fBconst sip_str_t *\fR\fIsip_get_replyto_uri_str\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 228      \fBint *\fR\fIerror\fR);
 229 .fi
 230
 231 .LP
 232 .nf
 233 \fBconst sip_str_t *\fR\fIsip_get_date_time\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 234      \fBint *\fR\fIerror\fR);
 235 .fi
 236
 237 .LP
 238 .nf
 239 \fBint\fR \fIsip_get_date_day\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 240      \fBint *\fR\fIerror\fR);
 241 .fi
 242
 243 .LP
 244 .nf
 245 \fBconst sip_str_t *\fR\fIsip_get_date_month\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 246      \fBint *\fR\fIerror\fR);
 247 .fi
 248
 249 .LP
 250 .nf
 251 \fBint\fR \fIsip_get_date_year\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 252      \fBint *\fR\fIerror\fR);
 253 .fi
 254
 255 .LP
 256 .nf
 257 \fBconst sip_str_t *\fR\fIsip_get_date_wkday\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 258      \fBint *\fR\fIerror\fR);
 259 .fi
 260
 261 .LP
 262 .nf
 263 \fBconst sip_str_t *\fR\fIsip_get_date_timezone\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 264      \fBint *\fR\fIerror\fR);
 265 .fi
 266
 267 .LP
 268 .nf
 269 \fBconst sip_str_t *\fR\fIsip_get_content_disp\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 270      \fBint *\fR\fIerror\fR);
 271 .fi
 272
 273 .LP
 274 .nf
 275 \fBconst sip_str_t *\fR\fIsip_get_content_enc\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 276      \fBint *\fR\fIerror\fR);
 277 .fi
 278
 279 .LP
 280 .nf
 281 \fBconst sip_str_t *\fR\fIsip_get_error_info_uri\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 282      \fBint *\fR\fIerror\fR);
 283 .fi
 284
 285 .LP
 286 .nf
 287 \fBint\fR \fIsip_get_expires\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 288      \fBint *\fR\fIerror\fR);
 289 .fi
 290
 291 .LP
 292 .nf
 293 \fBconst sip_str_t *\fR\fIsip_get_require\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 294      \fBint *\fR\fIerror\fR);
 295 .fi
 296
 297 .LP
 298 .nf
 299 \fBconst sip_str_t *\fR\fIsip_get_subject\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 300      \fBint *\fR\fIerror\fR);
 301 .fi
 302
 303 .LP
 304 .nf
 305 \fBconst sip_str_t *\fR\fIsip_get_supported\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 306      \fBint *\fR\fIerror\fR);
 307 .fi
 308
 309 .LP
 310 .nf
 311 \fBconst sip_str_t *\fR\fIsip_get_tstamp_delay\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 312      \fBint *\fR\fIerror\fR);
 313 .fi
 314
 315 .LP
 316 .nf
 317 \fBconst sip_str_t *\fR\fIsip_get_unsupported\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 318      \fBint *\fR\fIerror\fR);
 319 .fi
 320
 321 .LP
 322 .nf
 323 \fBconst sip_str_t *\fR\fIsip_get_server\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 324      \fBint *\fR\fIerror\fR);
 325 .fi
 326
 327 .LP
 328 .nf
 329 \fBconst sip_str_t *\fR\fIsip_get_user_agent\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 330      \fBint *\fR\fIerror\fR);
 331 .fi
 332
 333 .LP
 334 .nf
 335 \fBint\fR \fIsip_get_warning_code\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 336      \fBint *\fR\fIerror\fR);
 337 .fi
 338
 339 .LP
 340 .nf
 341 \fBconst sip_str_t *\fR\fIsip_get_warning_agent\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 342      \fBint *\fR\fIerror\fR);
 343 .fi
 344
 345 .LP
 346 .nf
 347 \fBconst sip_str_t *\fR\fIsip_get_warning_text\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 348      \fBint *\fR\fIerror\fR);
 349 .fi
 350
 351 .LP
 352 .nf
 353 \fBconst sip_str_t *\fR\fIsip_get_call_info_uri\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 354      \fBint *\fR\fIerror\fR);
 355 .fi
 356
 357 .LP
 358 .nf
 359 \fBconst sip_str_t *\fR\fIsip_get_in_reply_to\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 360      \fBint *\fR\fIerror\fR);
 361 .fi
 362
 363 .LP
 364 .nf
 365 \fBint\fR \fIsip_get_retry_after_time\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 366      \fBint *\fR\fIerror\fR);
 367 .fi
 368
 369 .LP
 370 .nf
 371 \fBconst sip_str_t *\fR\fIsip_get_retry_after_cmts\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 372      \fBint *\fR\fIerror\fR);
 373 .fi
 374
 375 .LP
 376 .nf
 377 \fBconst sip_str_t *\fR\fIsip_get_passertedid_display_name\fR
 378      (\fBsip_header_value_t\fR \fIvalue\fR, \fBint *\fR\fIerror\fR);
 379 .fi
 380
 381 .LP
 382 .nf
 383 \fBconst sip_str_t *\fR\fIsip_get_passertedid_uri_str\fR
 384      (\fBsip_header_value_t\fR \fIvalue\fR, \fBint *\fR\fIerror\fR);
 385 .fi
 386
 387 .LP
 388 .nf
 389 \fBint\fR \fIsip_get_rack_resp_num\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 390      \fBint *\fR\fIerror\fR);
 391 .fi
 392
 393 .LP
 394 .nf
 395 \fBint\fR sip_get_rack_cseq_num\fI\fR(\fBsip_msg_t\fR \fIsip_msg, int *error);\fR
 396 .fi
 397
 398 .LP
 399 .nf
 400 sip_method_t\fB\fR \fIsip_get_rack_method\fR(\fBsip_msg_t\fR \fIsip_msg\fR, \fBint *\fR\fIerror\fR);
 401 .fi
 402
 403 .LP
 404 .nf
 405 \fBint\fR \fIsip_get_rseq_resp_num\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 406      \fBint *\fR\fIerror\fR);
 407 .fi
 408
 409 .LP
 410 .nf
 411 \fBconst sip_str_t *\fR\fIsip_get_priv_value\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 412      \fBint *\fR\fIerror\fR);
 413 .fi
 414
 415 .LP
 416 .nf
 417 \fBconst sip_str_t *\fR\fIsip_get_author_scheme\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 418      \fBint *\fR\fIerror\fR);
 419 .fi
 420
 421 .LP
 422 .nf
 423 \fBconst sip_str_t *\fR\fIsip_get_author_param\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 424      \fBchar *\fR\fIname\fR, \fBint *\fR\fIerror\fR);
 425 .fi
 426
 427 .LP
 428 .nf
 429 \fBconst sip_str_t *\fR\fIsip_get_authen_info\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 430      \fBint *\fR\fIerror\fR);
 431 .fi
 432
 433 .LP
 434 .nf
 435 \fBconst sip_str_t *\fR\fIsip_get_proxy_authen_scheme\fR(\fBsip_msg_t\fR \fImsg\fR,
 436      \fBint *\fR\fIerror\fR);
 437 .fi
 438
 439 .LP
 440 .nf
 441 \fBconst sip_str_t *\fR\fIsip_get_proxy_authen_param\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 442      \fBchar *\fR\fIname\fR, \fBint *\fR\fIerror\fR);
 443 .fi
 444
 445 .LP
 446 .nf
 447 \fBconst sip_str_t *\fR\fIsip_get_proxy_author_scheme\fR(\fBsip_msg_t\fR \fImsg\fR,
 448      \fBint *\fR\fIerror\fR);
 449 .fi
 450
 451 .LP
 452 .nf
 453 \fBconst sip_str_t *\fR\fIsip_get_proxy_author_param\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 454      \fBchar *\fR\fIname\fR, \fBint *\fR\fIerror\fR);
 455 .fi
 456
 457 .LP
 458 .nf
 459 \fBconst sip_str_t *\fR\fIsip_get_proxy_require\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 460      \fBint *\fR\fIerror\fR);
 461 .fi
 462
 463 .LP
 464 .nf
 465 \fBconst sip_str_t *\fR\fIsip_get_www_authen_scheme\fR(\fBsip_msg_t\fR \fImsg\fR,
 466      \fBint *\fR\fIerror\fR);
 467 .fi
 468
 469 .LP
 470 .nf
 471 \fBconst sip_str_t *\fR\fIsip_get_www_authen_param\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 472      \fBchar *\fR\fIname\fR, \fBint *\fR\fIerror\fR);
 473 .fi
 474
 475 .LP
 476 .nf
 477 \fBconst sip_str_t *\fR\fIsip_get_allow_events\fR(\fBsip_header_value_t\fR \fIvalue,
 478      int *error);\fR
 479 .fi
 480
 481 .LP
 482 .nf
 483 \fBconst sip_str_t *\fR\fIsip_get_event\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 484      \fBint *\fR\fIerror\fR);
 485 .fi
 486
 487 .LP
 488 .nf
 489 \fBconst sip_str_t *\fR\fIsip_get_substate\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 490      \fBint *\fR\fIerror\fR);
 491 .fi
 492
 493 .LP
 494 .nf
 495 \fBconst sip_str_t *\fR\fIsip_get_content_lang\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 496      \fBint *\fR\fIerror\fR);
 497 .fi
 498
 499 .LP
 500 .nf
 501 \fBconst sip_str_t *\fR\fIsip_get_tstamp_value\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
 502      \fBint *\fR\fIerror\fR);
 503 .fi
 504
 505 .LP
 506 .nf
 507 \fBconst sip_str_t *\fR\fIsip_get_route_uri_str\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 508      \fBint *\fR\fIerror\fR);
 509 .fi
 510
 511 .LP
 512 .nf
 513 \fBconst sip_str_t *\fR\fIsip_get_route_display_name\fR(\fBsip_header_value_t\fR \fIvalue\fR,
 514      \fBint *\fR\fIerror\fR);
 515 .fi
 516
 517 .SH DESCRIPTION
 518 .sp
 519 .LP
 520 For functions that return a pointer of type \fBsip_str_t\fR, \fBsip_str_t\fR is
 521 supplied by:
 522 .sp
 523 .in +2
 524 .nf
 525 typedef struct sip_str {
 526      char       *sip_str_ptr;
 527      int        sip_str_len;
 528 }sip_str_t;
 529 .fi
 530 .in -2
 531
 532 .sp
 533 .LP
 534 The \fIsip_str_ptr\fR parameter points to the start of the returned value and
 535 \fIsip_str_len\fR supplies the length of the returned value.
 536 .sp
 537 .LP
 538 For example, given the following request line in a \fBSIP\fR message
 539 \fIsip_msg\fR that is input to \fBsip_get_request_uri_str()\fR:
 540 .sp
 541 .in +2
 542 .nf
 543 FROM : <Alice sip:alice@atlanta.com>;tag=1928301774
 544 .fi
 545 .in -2
 546
 547 .sp
 548 .LP
 549 the return is a pointer to \fIsip_str_t\fR with the \fIsip_str_ptr\fR member
 550 pointing to "\fBA\fR" of \fBAlice\fR and \fIsip_str_len\fR being set to
 551 \fB5\fR, the length of \fBAlice\fR.
 552 .sp
 553 .LP
 554 Access functions for headers that can have multiple values take the value as
 555 the input, while those that can have only one value take the \fBSIP\fR message
 556 \fIsip_msg\fR as the input.
 557 .sp
 558 .LP
 559 The \fBsip_get_contact_display_name()\fR, \fBsip_get_from_display_name()\fR,
 560 and \fBsip_get_to_display_name()\fR functions will return the display name, if
 561 present, from the \fBCONTACT\fR header value, \fBFROM\fR and \fBTO\fR header
 562 respectively.
 563 .sp
 564 .LP
 565 The \fBsip_get_contact_uri_str()\fR, \fBsip_get_from_uri_str()\fR, and
 566 \fBsip_get_to_uri_str()\fR functions will return the \fBURI\fR string from the
 567 \fBCONTACT\fR value, \fBFROM\fR and \fBTO\fR header respectively.
 568 .sp
 569 .LP
 570 The \fBsip_get_from_tag()\fR and \fBsip_get_to_tag()\fR functions will return
 571 the \fBTAG\fR parameter value, if present, from the \fBFROM\fR and \fBTO\fR
 572 header, respectively, in the provided \fBSIP\fR message \fIsip_msg\fR.
 573 .sp
 574 .LP
 575 The \fBsip_get_callid()\fR function will return the value from the
 576 \fBCALL-ID\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 577 .sp
 578 .LP
 579 The \fBsip_get_callseq_num()\fR function will return the call sequence number
 580 from the \fBCSEQ\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 581 .sp
 582 .LP
 583 The \fBsip_get_callseq_method()\fR function will return the method from the
 584 \fBCSEQ\fR header in the provided \fBSIP\fR message \fIsip_msg\fR. The method
 585 can be one of the following:
 586 .br
 587 .in +2
 588 INVITE
 589 .in -2
 590 .br
 591 .in +2
 592 ACK
 593 .in -2
 594 .br
 595 .in +2
 596 OPTIONS
 597 .in -2
 598 .br
 599 .in +2
 600 BYE
 601 .in -2
 602 .br
 603 .in +2
 604 CANCEL
 605 .in -2
 606 .br
 607 .in +2
 608 REGISTER
 609 .in -2
 610 .br
 611 .in +2
 612 REFER
 613 .in -2
 614 .br
 615 .in +2
 616 INFO
 617 .in -2
 618 .br
 619 .in +2
 620 SUBSCRIBE
 621 .in -2
 622 .br
 623 .in +2
 624 NOTIFY
 625 .in -2
 626 .br
 627 .in +2
 628 PRACK
 629 .in -2
 630 .br
 631 .in +2
 632 UNKNOWN
 633 .in -2
 634 .sp
 635 .LP
 636 The \fBsip_get_via_sent_by_host()\fR, \fBsip_get_via_sent_by_port()\fR,
 637 \fBsip_get_via_sent_protocol_version()\fR,
 638 \fBsip_get_via_sent_protocol_name()\fR, and \fBsip_get_via_sent_transport()\fR
 639 functions will return the sent-by host, port (if present), protocol version,
 640 protocol name and transport information from the provided \fBVIA\fR header
 641 value. Example, if the \fBVIA\fR value is given by \fBSIP/2.0/UDP
 642 bobspc.biloxi.com:5060\fR, then the sent-by host is "\fBbobspc.biloxi.com\fR",
 643 protocol name is "\fBSIP\fR", protocol version is "\fB2.0\fR", port is
 644 \fB5060\fR and transport is \fBUDP\fR.
 645 .sp
 646 .LP
 647 The \fBsip_get_maxforward()\fR function will return the value of the
 648 \fBMAX-FORWARDS\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 649 .br
 650 .in +2
 651 INVITE
 652 .in -2
 653 .br
 654 .in +2
 655 ACK
 656 .in -2
 657 .br
 658 .in +2
 659 OPTIONS
 660 .in -2
 661 .br
 662 .in +2
 663 BYE
 664 .in -2
 665 .br
 666 .in +2
 667 CANCEL
 668 .in -2
 669 .br
 670 .in +2
 671 REGISTER
 672 .in -2
 673 .br
 674 .in +2
 675 REFER
 676 .in -2
 677 .br
 678 .in +2
 679 INFO
 680 .in -2
 681 .br
 682 .in +2
 683 SUBSCRIBE
 684 .in -2
 685 .br
 686 .in +2
 687 NOTIFY
 688 .in -2
 689 .br
 690 .in +2
 691 PRACK
 692 .in -2
 693 .br
 694 .in +2
 695 UNKNOWN
 696 .in -2
 697 .sp
 698 .LP
 699 The \fBsip_get_content_length()\fR function will return the value of the
 700 \fBCONTENT-LENGTH\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 701 The method can return one of the following:
 702 .sp
 703 .LP
 704 The \fBsip_get_content_type()\fR and \fBsip_get_content_sub_type()\fR functions
 705 will return the value of the Type and Sub-Type field, respectively, from the
 706 \fBCONTENT-TYPE\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 707 .sp
 708 .LP
 709 The \fBsip_get_content()\fR function will return the message body from the
 710 provided \fBSIP\fR message \fIsip_msg\fR. The returned string is a copy of the
 711 message body and the caller is responsible for freeing the string after use.
 712 .sp
 713 .LP
 714 The \fBsip_get_accept_type()\fR and \fBsip_get_accept_sub_type()\fR functions
 715 will return the value of the Type and Sub-Type field, respectively, from the
 716 provided \fBACCEPT\fR header value.
 717 .sp
 718 .LP
 719 The \fBsip_get_accept_enc()\fR function will return the content-coding from the
 720 provided \fBACCEPT-ENCODING\fR header value.
 721 .sp
 722 .LP
 723 The \fBsip_get_accept_lang()\fR function will return the language  from the
 724 provided \fBACCEPT-LANGUAGE\fR header value.
 725 .sp
 726 .LP
 727 The \fBsip_get_alert_info_uri()\fR function will return the \fBURI\fR string
 728 from the provided \fBALERT-INFO\fR header value.
 729 .sp
 730 .LP
 731 The \fBsip_get_allow_method()\fR function will return the \fBSIP\fR method from
 732 the provided \fBALLOW\fR header value. The method can return one of the
 733 following:
 734 .br
 735 .in +2
 736 INVITE
 737 .in -2
 738 .br
 739 .in +2
 740 ACK
 741 .in -2
 742 .br
 743 .in +2
 744 OPTIONS
 745 .in -2
 746 .br
 747 .in +2
 748 BYE
 749 .in -2
 750 .br
 751 .in +2
 752 CANCEL
 753 .in -2
 754 .br
 755 .in +2
 756 REGISTER
 757 .in -2
 758 .br
 759 .in +2
 760 REFER
 761 .in -2
 762 .br
 763 .in +2
 764 INFO
 765 .in -2
 766 .br
 767 .in +2
 768 SUBSCRIBE
 769 .in -2
 770 .br
 771 .in +2
 772 NOTIFY
 773 .in -2
 774 .br
 775 .in +2
 776 PRACK
 777 .in -2
 778 .br
 779 .in +2
 780 UNKNOWN
 781 .in -2
 782 .sp
 783 .LP
 784 The \fBsip_get_min_expire()\fR function will return the time in seconds from
 785 the \fBMIN-EXPIRES\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 786 .sp
 787 .LP
 788 The \fBsip_get_mime_version()\fR function will return the \fBMIME\fR version
 789 string from the \fBMIME-VERSION\fR header in the provided \fBSIP\fR message
 790 \fIsip_msg\fR.
 791 .sp
 792 .LP
 793 The \fBsip_get_org()\fR function will return the organization string value from
 794 the \fBORGANIZATION\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 795 .sp
 796 .LP
 797 The \fBsip_get_priority()\fR function will return the priority string value
 798 from the \fBPRIORITY\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 799 .sp
 800 .LP
 801 The \fBsip_get_replyto_display_name()\fR and \fBsip_get_replyto_uri_str()\fR
 802 functions will return the display name (if present) and the \fBURI\fR string,
 803 respectively, from the \fBREPLY-TO\fR header in the provided \fBSIP\fR message
 804 \fIsip_msg\fR.
 805 .sp
 806 .LP
 807 The \fBsip_get_date_time()\fR, \fBsip_get_date_day()\fR,
 808 \fBsip_get_date_month()\fR, \fBsip_get_date_wkday()\fR,
 809 \fBsip_get_date_year()\fR and \fBsip_get_date_timezone()\fR functions will
 810 return the time, day, month, week day, year and timezone value from the
 811 \fBDATE\fR header in the provided \fBSIP\fR message \fIsip_msg\fR. Example, if
 812 the DATE header has the following value:
 813 .sp
 814 .in +2
 815 .nf
 816 Sat, 13 Nov 2010 23:29:00 GMT
 817 .fi
 818 .in -2
 819
 820 .sp
 821 .LP
 822 the time is "\fB23:29:00\fR ", week day is "\fBSat\fR", day is "\fB13\fR",
 823 month is  "\fBNov\fR", year is "\fB2010\fR", timezone is "\fBGMT\fR".
 824 .sp
 825 .LP
 826 The \fBsip_get_content_disp()\fR function will return the content-disposition
 827 type from the \fBCONTENT-DISPOSITION\fR header in the provided \fBSIP\fR
 828 message \fIsip_msg\fR.
 829 .sp
 830 .LP
 831 The \fBsip_get_content_enc()\fR function will return the content-coding value
 832 from the \fBCONTENT-ENCODING\fR header value.
 833 .sp
 834 .LP
 835 The \fBsip_get_error_info_uri()\fR function will return the \fBURI\fR string
 836 from the provided \fBERROR-INFO\fR header value.
 837 .sp
 838 .LP
 839 The \fBsip_get_expires()\fR function will return the time in seconds from the
 840 \fBEXPIRES\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 841 .sp
 842 .LP
 843 The \fBsip_get_require()\fR function will return the option-tag value from the
 844 provided \fBREQUIRE\fR header value.
 845 .sp
 846 .LP
 847 The \fBsip_get_subject()\fR function will return the value of the \fBSUBJECT\fR
 848 header in the provided \fBSIP\fR message \fIsip_msg\fR.
 849 .sp
 850 .LP
 851 The \fBsip_get_supported()\fR function will return the extension value from the
 852 provided \fBSUPPORTED\fR header value.
 853 .sp
 854 .LP
 855 The \fBsip_get_tstamp_delay()\fR function will return the value from the
 856 \fBTIMESTAMP\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 857 .sp
 858 .LP
 859 The \fBsip_get_unsupported()\fR function will return the extension value from
 860 the provided \fBUNSUPPORTED\fR header value.
 861 .sp
 862 .LP
 863 The \fBsip_get_server()\fR function will return the value from the \fBSERVER\fR
 864 header in the provided \fBSIP\fR message \fIsip_msg\fR.
 865 .sp
 866 .LP
 867 The \fBsip_get_user_agent()\fR function will return the value from the
 868 \fBUSER-AGENT\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 869 .sp
 870 .LP
 871 The \fBsip_get_warning_code()\fR, \fBsip_get_warning_agent()\fR, and
 872 \fBsip_get_warning_text()\fR functions will return the value of the warn-code,
 873 warn-agent and warn-text, respectively, in the provided \fBWARNING\fR header
 874 value.
 875 .sp
 876 .LP
 877 The \fBsip_get_call_info_uri()\fR function will return the \fBURI\fR string in
 878 the provided \fBCALL-INFO\fR header value.
 879 .sp
 880 .LP
 881 The \fBsip_get_in_reply_to()\fR function will return the Call-Id value in the
 882 provided \fBIN-REPLY-TO\fR header value.
 883 .sp
 884 .LP
 885 The \fBsip_get_retry_after_time()\fR, and \fBsip_get_retry_after_cmts()\fR
 886 functions return the time and comments (if any), respectively, from the
 887 \fBRETRY-AFTER\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 888 .sp
 889 .LP
 890 The \fBsip_get_passertedid_display_name()\fR and
 891 \fBsip_get_passertedid_uri_str()\fR functions will return the display name (if
 892 any) and the \fBURI\fR string, respectively, in the provided
 893 \fBP-ASSERTED-IDENTITY\fR header value.
 894 .sp
 895 .LP
 896 The \fBsip_get_ppreferredid_display_name()\fR and
 897 \fBsip_get_ppreferredid_uri_str()\fR functions will return the display name (if
 898 any) and the \fBURI\fR string, respectively, in the provided
 899 \fBP-PREFERRED-IDENTITY\fR header value.
 900 .sp
 901 .LP
 902 The \fBsip_get_rack_resp_num()\fR, \fBsip_get_rack_cseq_num()\fR, and
 903 \fBsip_get_rack_method()\fR functions will return the response-number, the
 904 \fBCSEQ\fR number and the \fBSIP\fR method from the \fBRACK\fR header in the
 905 provided \fBSIP\fR message \fIsip_msg\fR. The method can return one of the
 906 following:
 907 .br
 908 .in +2
 909 INVITE
 910 .in -2
 911 .br
 912 .in +2
 913 ACK
 914 .in -2
 915 .br
 916 .in +2
 917 OPTIONS
 918 .in -2
 919 .br
 920 .in +2
 921 BYE
 922 .in -2
 923 .br
 924 .in +2
 925 CANCEL
 926 .in -2
 927 .br
 928 .in +2
 929 REGISTER
 930 .in -2
 931 .br
 932 .in +2
 933 REFER
 934 .in -2
 935 .br
 936 .in +2
 937 INFO
 938 .in -2
 939 .br
 940 .in +2
 941 SUBSCRIBE
 942 .in -2
 943 .br
 944 .in +2
 945 NOTIFY
 946 .in -2
 947 .br
 948 .in +2
 949 PRACK
 950 .in -2
 951 .br
 952 .in +2
 953 UNKNOWN
 954 .in -2
 955 .sp
 956 .LP
 957 The \fBsip_get_rseq_resp_num()\fR function will return the response-number, the
 958 \fBRSEQ\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 959 .sp
 960 .LP
 961 The \fBsip_get_priv_value()\fR function will return the priv-value in the
 962 provided \fBPRIVACY\fR header value.
 963 .sp
 964 .LP
 965 The \fBsip_get_route_uri_str()\fR and \fBsip_get_route_display_name()\fR
 966 functions will return the \fBURI\fR string, and display name (if present) from
 967 the provided \fBROUTE\fR or \fBRECORD-ROUTE\fR header value.
 968 .sp
 969 .LP
 970 The \fBsip_get_author_scheme()\fR function will return the scheme from the
 971 \fBAUTHORIZATION\fR header in the provided \fBSIP\fR message \fIsip_msg\fR.
 972 .sp
 973 .LP
 974 The \fBsip_get_author_param()\fR function will return the value of the
 975 parameter specified in name from the \fBAUTHORIZATION\fR header in the
 976 \fBSIP\fR message \fIsip_msg\fR.
 977 .sp
 978 .LP
 979 The \fBsip_get_authen_info()\fR function will return the authentication
 980 information from the provided \fBAUTHORIZATION-INFO\fR header value.
 981 .sp
 982 .LP
 983 The \fBsip_get_proxy_authen_scheme()\fR function will return the scheme from
 984 the \fBPROXY-AUTHENTICATE\fR header in the \fBSIP\fR message \fIsip_msg\fR.
 985 .sp
 986 .LP
 987 The \fBsip_get_proxy_authen_param()\fR function will return the value of the
 988 parameter in name from the \fBPROXY-AUTHENTICATE\fR header in the \fBSIP\fR
 989 message \fIsip_msg\fR.
 990 .sp
 991 .LP
 992 The \fBsip_get_proxy_author_scheme()\fR function will return the value of the
 993 scheme from the \fBPROXY-AUTHORIZATION\fR header in the \fBSIP\fR message
 994 \fIsip_msg\fR.
 995 .sp
 996 .LP
 997 The \fBsip_get_proxy_author_param()\fR function will return the value of the
 998 parameter specified in name from the \fBPROXY-AUTHORIZATION\fR header in the
 999 \fBSIP\fR message \fIsip_msg\fR.
1000 .sp
1001 .LP
1002 The \fBsip_get_proxy_require()\fR function will return the option-tag from the
1003 provided \fBPROXY-REQUIRE\fR header value.
1004 .sp
1005 .LP
1006 The \fBsip_get_www_authen_scheme()\fR function will return the challenge from
1007 the \fBWWW-AUTHENTICATE\fR header in the \fBSIP\fR message \fIsip_msg\fR.
1008 .sp
1009 .LP
1010 The \fBsip_get_www_authen_param()\fR function will return the value of the
1011 parameter specified in name from the \fBWWW-AUTHENTICATE\fR header in the
1012 \fBSIP\fR message \fIsip_msg\fR.
1013 .sp
1014 .LP
1015 The \fBsip_get_allow_events()\fR function returns the value of the allowed
1016 event from the provided \fBALLOW-EVENTS\fR header value.
1017 .sp
1018 .LP
1019 The \fBsip_get_event()\fR function returns the event in the \fBEVENT\fR header
1020 in the \fBSIP\fR message \fIsip_msg\fR.
1021 .sp
1022 .LP
1023 The \fBsip_get_substate()\fR function the subscription state from the
1024 \fBSUBSCRIPTION-STATE\fR header in the provided \fBSIP\fR message
1025 \fIsip_msg\fR.
1026 .sp
1027 .LP
1028 The \fBsip_get_content_lang()\fR function will return the language from the
1029 provided \fBCONTENT-LANGUAGE\fR value.
1030 .sp
1031 .LP
1032 The \fBsip_get_tstamp_value()\fR function will return the timestamp value from
1033 the \fBTIMESTAMP\fR header in the \fBSIP\fR message \fIsip_msg\fR.
1034 .SH RETURN VALUES
1035 .sp
1036 .LP
1037 For functions that return a pointer to \fIsip_str_t\fR, the return value is the
1038 specified value on success or \fBNULL\fR in case of error. For functions that
1039 return an integer, the return value is the specified value on success and
1040 \fB-1\fR on error.
1041 .sp
1042 .LP
1043 The value of \fBerrno\fR is not changed by these calls in the event of an
1044 error.
1045 .SH ERRORS
1046 .sp
1047 .LP
1048 These functions take a pointer to an integer \fIerror\fR as an argument. If the
1049 error is non-null, one of the following values is set:
1050 .sp
1051 .ne 2
1052 .na
1053 \fB\fBEINVAL\fR\fR
1054 .ad
1055 .RS 10n
1056 The input \fBSIP\fR message \fIsip_msg\fR or the header value is null; or the
1057 specified header/header value is deleted.
1058 .RE
1059
1060 .sp
1061 .ne 2
1062 .na
1063 \fB\fBEPROTO\fR\fR
1064 .ad
1065 .RS 10n
1066 The header value is not present or invalid. The parser could not parse it
1067 correctly.
1068 .RE
1069
1070 .sp
1071 .ne 2
1072 .na
1073 \fB\fBENOMEM\fR\fR
1074 .ad
1075 .RS 10n
1076 There is an error allocating memory for the return value.
1077 .RE
1078
1079 .sp
1080 .LP
1081 On success, the value of the location pointed to by \fIerror\fR is set to
1082 \fB0\fR.
1083 .SH ATTRIBUTES
1084 .sp
1085 .LP
1086 See \fBattributes\fR(5) for descriptions of the following attributes:
1087 .sp
1088
1089 .sp
1090 .TS
1091 box;
1092 c | c
1093 l | l .
1094 ATTRIBUTE TYPE  ATTRIBUTE VALUE
1095 _
1096 Interface Stability     Committed
1097 _
1098 MT-Level        MT-Safe
1099 .TE
1100
1101 .SH SEE ALSO
1102 .sp
1103 .LP
1104 \fBlibsip\fR(3LIB)