1sip_get_param_valuSee(s3sSiIoPn)Initiation Protocol Library Fsuinpc_tgieotn_sparam_value(3SIP)
2
3
4
6 sip_get_param_value, sip_get_params, sip_is_param_present - get parame‐
7 ter information for a SIP header value
8
10 cc [ flag ... ] file ... -lsip [ library ... ]
11 #include <sip.h>
12
13 const sip_str_t *sip_get_param_value
14 (sip_header_value_t header_value, char *param_name, int *error);
15
16
17 const sip_param_t *sip_get_params
18 (sip_header_value_t header_value, int *error);;
19
20
21 boolean_t sip_is_param_present
22 (const sip_param_t *param_list, char *param_name, int param_len);
23
24
26 The sip_get_param_value() function returns the value for the parameter
27 name specified by param_name from the SIP header value header_value.
28
29
30 For functions that return a pointer of type sip_str_t, sip_str_t is
31 supplied by:
32
33 typedef struct sip_str {
34 char *sip_str_ptr;
35 int sip_str_len;
36 }sip_str_t;
37
38
39
40 The sip_str_ptr parameter points to the start of the returned value and
41 sip_str_len supplies the length of the returned value.
42
43
44 The sip_get_params() function returns the parameter list, if any, for
45 the SIP header value header_value.
46
47
48 The sip_is_param_present() function returns B_TRUE if the parameter
49 specified by param_name of length supplied in param_len is present in
50 the parameter list, param_list. Otherwise, it returns B_FALSE.
51
53 With the exception of sip_is_param_present(), these functions return
54 the queried value on success and NULL on failure.
55
56
57 The value of errno is not changed by these calls in the event of an
58 error.
59
61 If the error is non-null, one of the following values is set:
62
63 EINVAL If any of the required input is NULL or if the specified SIP
64 header value is marked deleted.
65
66
67 EPROTO If the returned SIP header value is invalid (i.e. the parser
68 encountered errors when parsing the value).
69
70
71
72 On success, the value of the location pointed to by error is set to 0.
73
75 See attributes(5) for descriptions of the following attributes:
76
77
78
79
80 ┌─────────────────────────────┬─────────────────────────────┐
81 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
82 ├─────────────────────────────┼─────────────────────────────┤
83 │Interface Stability │Committed │
84 ├─────────────────────────────┼─────────────────────────────┤
85 │MT-Level │MT-Safe │
86 └─────────────────────────────┴─────────────────────────────┘
87
89 libsip(3LIB)
90
91
92
93SunOS 5.11 25 Jan 2007 sip_get_param_value(3SIP)