/usr/share/gtk-doc/html/libmbim-glib/libmbim-glib-USSD.html is in libmbim-glib-doc 1.6.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>USSD</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libmbim-glib Reference Manual">
<link rel="up" href="ch02.html" title="Services">
<link rel="prev" href="libmbim-glib-SMS.html" title="SMS">
<link rel="next" href="libmbim-glib-Auth.html" title="Auth">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libmbim-glib-SMS.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libmbim-glib Reference Manual</th>
<td><a accesskey="n" href="libmbim-glib-Auth.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libmbim-glib-USSD.synopsis" class="shortcut">Top</a>
|
<a href="#libmbim-glib-USSD.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libmbim-glib-USSD"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libmbim-glib-USSD.top_of_page"></a>USSD</span></h2>
<p>USSD</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libmbim-glib-USSD.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="MbimMessage.html" title="MbimMessage"><span class="returnvalue">MbimMessage</span></a> * <a class="link" href="libmbim-glib-USSD.html#mbim-message-ussd-set-new" title="mbim_message_ussd_set_new ()">mbim_message_ussd_set_new</a> (<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdAction"><span class="type">MbimUssdAction</span></a> action</code></em>,
<em class="parameter"><code><span class="type">guint32</span> data_coding_scheme</code></em>,
<em class="parameter"><code>const <span class="type">guint32</span> payload_size</code></em>,
<em class="parameter"><code>const <span class="type">guint8</span> *payload</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libmbim-glib-USSD.html#mbim-message-ussd-response-parse" title="mbim_message_ussd_response_parse ()">mbim_message_ussd_response_parse</a> (<em class="parameter"><code>const <a class="link" href="MbimMessage.html" title="MbimMessage"><span class="type">MbimMessage</span></a> *message</code></em>,
<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdResponse"><span class="type">MbimUssdResponse</span></a> *response</code></em>,
<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdSessionState"><span class="type">MbimUssdSessionState</span></a> *session_state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *data_coding_scheme</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *payload_size</code></em>,
<em class="parameter"><code>const <span class="type">guint8</span> **payload</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libmbim-glib-USSD.html#mbim-message-ussd-notification-parse" title="mbim_message_ussd_notification_parse ()">mbim_message_ussd_notification_parse</a>
(<em class="parameter"><code>const <a class="link" href="MbimMessage.html" title="MbimMessage"><span class="type">MbimMessage</span></a> *message</code></em>,
<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdResponse"><span class="type">MbimUssdResponse</span></a> *response</code></em>,
<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdSessionState"><span class="type">MbimUssdSessionState</span></a> *session_state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *data_coding_scheme</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *payload_size</code></em>,
<em class="parameter"><code>const <span class="type">guint8</span> **payload</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libmbim-glib-USSD.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libmbim-glib-USSD.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="mbim-message-ussd-set-new"></a><h3>mbim_message_ussd_set_new ()</h3>
<pre class="programlisting"><a class="link" href="MbimMessage.html" title="MbimMessage"><span class="returnvalue">MbimMessage</span></a> * mbim_message_ussd_set_new (<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdAction"><span class="type">MbimUssdAction</span></a> action</code></em>,
<em class="parameter"><code><span class="type">guint32</span> data_coding_scheme</code></em>,
<em class="parameter"><code>const <span class="type">guint32</span> payload_size</code></em>,
<em class="parameter"><code>const <span class="type">guint8</span> *payload</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Create a new request for the '' set command in the 'USSD' service.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the 'Action' field, given as a <a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdAction"><span class="type">MbimUssdAction</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_coding_scheme</code></em> :</span></p></td>
<td>the 'DataCodingScheme' field, given as a <span class="type">guint32</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>payload_size</code></em> :</span></p></td>
<td>size of the payload array.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
<td>the 'Payload' field, given as an array of <span class="type">guint8</span> values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for error or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated <a class="link" href="MbimMessage.html" title="MbimMessage"><span class="type">MbimMessage</span></a>, which should be freed with <a class="link" href="MbimMessage.html#mbim-message-unref" title="mbim_message_unref ()"><code class="function">mbim_message_unref()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mbim-message-ussd-response-parse"></a><h3>mbim_message_ussd_response_parse ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> mbim_message_ussd_response_parse (<em class="parameter"><code>const <a class="link" href="MbimMessage.html" title="MbimMessage"><span class="type">MbimMessage</span></a> *message</code></em>,
<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdResponse"><span class="type">MbimUssdResponse</span></a> *response</code></em>,
<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdSessionState"><span class="type">MbimUssdSessionState</span></a> *session_state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *data_coding_scheme</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *payload_size</code></em>,
<em class="parameter"><code>const <span class="type">guint8</span> **payload</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Create a new request for the 'Payload' response command in the 'USSD' service.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the <a class="link" href="MbimMessage.html" title="MbimMessage"><span class="type">MbimMessage</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td>
<td>return location for a <a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdResponse"><span class="type">MbimUssdResponse</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the 'Response' field is not needed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session_state</code></em> :</span></p></td>
<td>return location for a <a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdSessionState"><span class="type">MbimUssdSessionState</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the 'SessionState' field is not needed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_coding_scheme</code></em> :</span></p></td>
<td>return location for a <span class="type">guint32</span>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the 'DataCodingScheme' field is not needed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>payload_size</code></em> :</span></p></td>
<td>return location for the size of the payload array.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
<td>return location for an array of <span class="type">guint8</span> values. Do not free the returned value, it is owned by <em class="parameter"><code>message</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for error or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the message was correctly parsed, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>error</code></em> is set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mbim-message-ussd-notification-parse"></a><h3>mbim_message_ussd_notification_parse ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> mbim_message_ussd_notification_parse
(<em class="parameter"><code>const <a class="link" href="MbimMessage.html" title="MbimMessage"><span class="type">MbimMessage</span></a> *message</code></em>,
<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdResponse"><span class="type">MbimUssdResponse</span></a> *response</code></em>,
<em class="parameter"><code><a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdSessionState"><span class="type">MbimUssdSessionState</span></a> *session_state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *data_coding_scheme</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *payload_size</code></em>,
<em class="parameter"><code>const <span class="type">guint8</span> **payload</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Create a new request for the 'Payload' notification command in the 'USSD' service.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the <a class="link" href="MbimMessage.html" title="MbimMessage"><span class="type">MbimMessage</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td>
<td>return location for a <a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdResponse"><span class="type">MbimUssdResponse</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the 'Response' field is not needed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session_state</code></em> :</span></p></td>
<td>return location for a <a class="link" href="libmbim-glib-Enumerations-and-Flags.html#MbimUssdSessionState"><span class="type">MbimUssdSessionState</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the 'SessionState' field is not needed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_coding_scheme</code></em> :</span></p></td>
<td>return location for a <span class="type">guint32</span>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the 'DataCodingScheme' field is not needed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>payload_size</code></em> :</span></p></td>
<td>return location for the size of the payload array.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
<td>return location for an array of <span class="type">guint8</span> values. Do not free the returned value, it is owned by <em class="parameter"><code>message</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for error or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the message was correctly parsed, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>error</code></em> is set.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|