updates.
[website.git] / docs / toolkit / manual / silcbuffmt-SILC_STR_*_NSTRING.html
1
2 <html>
3 <head>
4  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-a" />
5  <meta http-equiv="Content-Language" content="en" />
6  <meta name="description" content="SILC Secure Internet Live Conferencing" />
7  <meta name="keywords" content="SILC, secure, chat, protocol, cipher, encrypt, SKE" />
8  <meta content="INDEX, FOLLOW" name="ROBOTS" />
9  <style type="text/css">
10   <!--
11   body { color: #000000; background: #f0f0f0; font-family: Helvetica, Arial, Sans-serif; }
12   a:link { text-decoration: none; color: #2f488f; }
13   a:visited { text-decoration: none;color: #2f488f; }
14   a:active { text-decoration: none; color: #2f488f; }
15   -->
16  </style>
17 </head>
18
19 <body topmargin="0" leftmargin="0" marginheight="0" marginwidth="0">
20
21 <table border="0" cellspacing="0" cellpadding="6" width="100%">
22  <tr valign="top" bgcolor="#dddddd">
23   <td><small>Copyright &copy; 2001 - 2007 SILC Project<br />
24     <a href="http://silcnet.org">SILC Project Website</a></small></td>
25   <td align="right"><small>
26    <a href="index.html">SILC Toolkit Reference Manual</a><br />
27    <a href="toolkit_index.html">Index</a></small></td>
28    </small></td>
29  </tr>
30 </table>
31 <table border="0" cellspacing="0" cellpadding="0" width="100%">
32 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
33 </table>
34
35 <table cellpadding="0" cellspacing="0" border="0">
36  <tr valign="top">
37
38   <td width="200" bgcolor="#f0f0f0">
39    <img src="space.gif" width="1" height="1" border="0" alt="">
40    <table width="100%" cellpadding="2" cellspacing="2" border="0">
41     <tr valign="top"><td>
42 <br />
43 <small>
44 <!-- Template file for the big index that appears in the Toolkit reference
45 manual on the left side.  With this file it is possible to add other than
46 automatically generated links to that list. -->
47
48 <a href="index.html"><img src="box.gif" border="0" alt="">SILC Toolkit Reference Manual</a><br />
49
50
51 <a href=silccryptlib.html><img src=box.gif border=0 alt=>SILC Crypto Library</a><br />
52 &nbsp;&nbsp;&nbsp; <a href=silcrng_intro.html><img src=box2.gif border=0 alt=>Introduction to SILC RNG</a><br />
53 &nbsp;&nbsp;&nbsp; <a href=silcrng.html><img src=box2.gif border=0 alt=>SILC RNG Interface</a><br />
54 &nbsp;&nbsp;&nbsp; <a href=silccipher.html><img src=box2.gif border=0 alt=>SILC Cipher API</a><br />
55 &nbsp;&nbsp;&nbsp; <a href=silcpkcs.html><img src=box2.gif border=0 alt=>SILC PKCS API</a><br />
56 &nbsp;&nbsp;&nbsp; <a href=silcpk.html><img src=box2.gif border=0 alt=>SILC Public Key API</a><br />
57 &nbsp;&nbsp;&nbsp; <a href=silcpkcs1.html><img src=box2.gif border=0 alt=>SILC PKCS #1 API</a><br />
58 &nbsp;&nbsp;&nbsp; <a href=silchash.html><img src=box2.gif border=0 alt=>SILC Hash Interface</a><br />
59 &nbsp;&nbsp;&nbsp; <a href=silchmac.html><img src=box2.gif border=0 alt=>SILC HMAC Interface</a><br />
60 <a href=silccorelib.html><img src=box.gif border=0 alt=>SILC Core Library</a><br />
61 &nbsp;&nbsp;&nbsp; <a href=silcauth.html><img src=box2.gif border=0 alt=>SILC Authentication Interface</a><br />
62 &nbsp;&nbsp;&nbsp; <a href=silcmessage.html><img src=box2.gif border=0 alt=>SILC Message Interface</a><br />
63 &nbsp;&nbsp;&nbsp; <a href=silcchannel.html><img src=box2.gif border=0 alt=>SILC Channel Interface</a><br />
64 &nbsp;&nbsp;&nbsp; <a href=silccommand.html><img src=box2.gif border=0 alt=>SILC Command Interface</a><br />
65 &nbsp;&nbsp;&nbsp; <a href=silcnotify.html><img src=box2.gif border=0 alt=>SILC Notify Interface</a><br />
66 &nbsp;&nbsp;&nbsp; <a href=silcstatus.html><img src=box2.gif border=0 alt=>SILC Status Types</a><br />
67 &nbsp;&nbsp;&nbsp; <a href=silcmode.html><img src=box2.gif border=0 alt=>SILC Modes</a><br />
68 &nbsp;&nbsp;&nbsp; <a href=silcid.html><img src=box2.gif border=0 alt=>SILC ID Interface</a><br />
69 &nbsp;&nbsp;&nbsp; <a href=silcargument.html><img src=box2.gif border=0 alt=>SILC Argument Interface</a><br />
70 &nbsp;&nbsp;&nbsp; <a href=silcattrs.html><img src=box2.gif border=0 alt=>SILC Attributes Interface</a><br />
71 &nbsp;&nbsp;&nbsp; <a href=silcpacket.html><img src=box2.gif border=0 alt=>Packet Engine Interface</a><br />
72 &nbsp;&nbsp;&nbsp; <a href=silcpubkey.html><img src=box2.gif border=0 alt=>SILC Public Key Payload Interface</a><br />
73 <a href=silcskelib.html><img src=box.gif border=0 alt=>SILC Key Exchange Library</a><br />
74 &nbsp;&nbsp;&nbsp; <a href=silcske.html><img src=box2.gif border=0 alt=>SILC SKE Interface</a><br />
75 &nbsp;&nbsp;&nbsp; <a href=silcconnauth.html><img src=box2.gif border=0 alt=>SILC Connection Authentication Interface</a><br />
76 <a href=silcvcardlib.html><img src=box.gif border=0 alt=>SILC VCard Library</a><br />
77 &nbsp;&nbsp;&nbsp; <a href=silcvcard.html><img src=box2.gif border=0 alt=>SILC VCard Interface</a><br />
78 <a href=silcmathlib.html><img src=box.gif border=0 alt=>SILC Math Library</a><br />
79 &nbsp;&nbsp;&nbsp; <a href=silcmp.html><img src=box2.gif border=0 alt=>SILC MP Interface</a><br />
80 &nbsp;&nbsp;&nbsp; <a href=silcmath.html><img src=box2.gif border=0 alt=>SILC Math Interface</a><br />
81 <a href=silcclientlib.html><img src=box.gif border=0 alt=>SILC Client Library</a><br />
82 &nbsp;&nbsp;&nbsp; <a href=silcclient_using.html><img src=box2.gif border=0 alt=>Using SILC Client Library Tutorial</a><br />
83 &nbsp;&nbsp;&nbsp; <a href=command_reply_args.html><img src=box2.gif border=0 alt=>Arguments for <b>command_reply</b> Client Operation</a><br />
84 &nbsp;&nbsp;&nbsp; <a href=silcstatus_args.html><img src=box2.gif border=0 alt=>SilcStatus Error Arguments in <b>command_reply</b> Client Operation</a><br />
85 &nbsp;&nbsp;&nbsp; <a href=notifyargs.html><img src=box2.gif border=0 alt=>Arguments for <b>notify</b> Client Operation</a><br />
86 &nbsp;&nbsp;&nbsp; <a href=silcclient_unicode.html><img src=box2.gif border=0 alt=>Unicode and UTF-8 Strings in Client Library</a><br />
87 &nbsp;&nbsp;&nbsp; <a href=silcclient.html><img src=box2.gif border=0 alt=>Client Library Interface Reference</a><br />
88 &nbsp;&nbsp;&nbsp; <a href=silcclient_entry.html><img src=box2.gif border=0 alt=>Client Entry Interface Reference</a><br />
89 <a href=silcasn1lib.html><img src=box.gif border=0 alt=>SILC ASN.1 Library</a><br />
90 &nbsp;&nbsp;&nbsp; <a href=silcasn1.html><img src=box2.gif border=0 alt=>SILC ASN.1 Interface</a><br />
91 &nbsp;&nbsp;&nbsp; <a href=silcber.html><img src=box2.gif border=0 alt=>SILC BER interface</a><br />
92 <a href=silchttplib.html><img src=box.gif border=0 alt=>SILC HTTP Library</a><br />
93 &nbsp;&nbsp;&nbsp; <a href=silchttpserver.html><img src=box2.gif border=0 alt=>SILC HTTP Server Interface</a><br />
94 &nbsp;&nbsp;&nbsp; <a href=silchttpphp.html><img src=box2.gif border=0 alt=>SILC HTTP PHP Translator</a><br />
95 <a href=silcutillib.html><img src=box.gif border=0 alt=>SILC Utility Library</a><br />
96 &nbsp;&nbsp;&nbsp; <a href=silctypes.html><img src=box2.gif border=0 alt=>Basic Types and Definitions</a><br />
97 &nbsp;&nbsp;&nbsp; <a href=silcbuffer.html><img src=box2.gif border=0 alt=>Data Buffer Interface</a><br />
98 &nbsp;&nbsp;&nbsp; <a href=silcbuffmt.html><img src=box2.gif border=0 alt=>Data Buffer Format Interface</a><br />
99 &nbsp;&nbsp;&nbsp; <a href=silchashtable.html><img src=box2.gif border=0 alt=>Hash Table Interface</a><br />
100 &nbsp;&nbsp;&nbsp; <a href=silcmemory.html><img src=box2.gif border=0 alt=>Memory Allocation Interface</a><br />
101 &nbsp;&nbsp;&nbsp; <a href=silcstack.html><img src=box2.gif border=0 alt=>Data Stack (memory pool) Interface</a><br />
102 &nbsp;&nbsp;&nbsp; <a href=silcfsm.html><img src=box2.gif border=0 alt=>Finite State Machine Interface</a><br />
103 &nbsp;&nbsp;&nbsp; <a href=silcthread.html><img src=box2.gif border=0 alt=>Thread Interface</a><br />
104 &nbsp;&nbsp;&nbsp; <a href=silcmutex.html><img src=box2.gif border=0 alt=>Mutual Exclusion Lock Interface</a><br />
105 &nbsp;&nbsp;&nbsp; <a href=silccond.html><img src=box2.gif border=0 alt=>Condition Variable Interface</a><br />
106 &nbsp;&nbsp;&nbsp; <a href=silcatomic.html><img src=box2.gif border=0 alt=>Atomic Operations Interface</a><br />
107 &nbsp;&nbsp;&nbsp; <a href=silcnet.html><img src=box2.gif border=0 alt=>Network (TCP and UDP) Interface</a><br />
108 &nbsp;&nbsp;&nbsp; <a href=silcschedule.html><img src=box2.gif border=0 alt=>Scheduler Interface</a><br />
109 &nbsp;&nbsp;&nbsp; <a href=silcasync.html><img src=box2.gif border=0 alt=>Asynchronous Operation Interface</a><br />
110 &nbsp;&nbsp;&nbsp; <a href=silcstream.html><img src=box2.gif border=0 alt=>Abstract Stream Interface</a><br />
111 &nbsp;&nbsp;&nbsp; <a href=silcsocketstream.html><img src=box2.gif border=0 alt=>Socket Stream Interface</a><br />
112 &nbsp;&nbsp;&nbsp; <a href=silcfdstream.html><img src=box2.gif border=0 alt=>File Descriptor Stream Interface</a><br />
113 &nbsp;&nbsp;&nbsp; <a href=silcfileutil.html><img src=box2.gif border=0 alt=>File Utility Functions</a><br />
114 &nbsp;&nbsp;&nbsp; <a href=silcstrutil.html><img src=box2.gif border=0 alt=>String Utility Interface</a><br />
115 &nbsp;&nbsp;&nbsp; <a href=silcsnprintf.html><img src=box2.gif border=0 alt=>Snprintf Interface</a><br />
116 &nbsp;&nbsp;&nbsp; <a href=silcutf8.html><img src=box2.gif border=0 alt=>UTF-8 String Interface</a><br />
117 &nbsp;&nbsp;&nbsp; <a href=silcstringprep.html><img src=box2.gif border=0 alt=>Stringprep Interface</a><br />
118 &nbsp;&nbsp;&nbsp; <a href=silcutil.html><img src=box2.gif border=0 alt=>Utility Functions</a><br />
119 &nbsp;&nbsp;&nbsp; <a href=silclist.html><img src=box2.gif border=0 alt=>List Interface</a><br />
120 &nbsp;&nbsp;&nbsp; <a href=silcdlist.html><img src=box2.gif border=0 alt=>Dynamic List Interface</a><br />
121 &nbsp;&nbsp;&nbsp; <a href=silcmime.html><img src=box2.gif border=0 alt=>MIME Interface</a><br />
122 &nbsp;&nbsp;&nbsp; <a href=silctime.html><img src=box2.gif border=0 alt=>Time Utility Functions</a><br />
123 &nbsp;&nbsp;&nbsp; <a href=silclog.html><img src=box2.gif border=0 alt=>Logging Interface</a><br />
124 &nbsp;&nbsp;&nbsp; <a href=silcconfig.html><img src=box2.gif border=0 alt=>Config File Interface</a><br />
125 <a href=silcskrlib.html><img src=box.gif border=0 alt=>SILC Key Repository Library</a><br />
126 &nbsp;&nbsp;&nbsp; <a href=silcskr.html><img src=box2.gif border=0 alt=>SILC SKR Interface</a><br />
127 <a href=silcaputillib.html><img src=box.gif border=0 alt=>SILC Application Utility Library</a><br />
128 &nbsp;&nbsp;&nbsp; <a href=silcapputil.html><img src=box2.gif border=0 alt=>SILC Application Utilities</a><br />
129 &nbsp;&nbsp;&nbsp; <a href=silcidcache.html><img src=box2.gif border=0 alt=>SILC ID Cache Interface</a><br />
130 <a href=silcsftplib.html><img src=box.gif border=0 alt=>SILC SFTP Library</a><br />
131 &nbsp;&nbsp;&nbsp; <a href=silcsftp.html><img src=box2.gif border=0 alt=>SILC SFTP Interface</a><br />
132 &nbsp;&nbsp;&nbsp; <a href=silcsftp_fs.html><img src=box2.gif border=0 alt=>SFTP Filesystems Interface</a><br />
133
134 <br />
135 <b>Resource Links</b>
136 <br />
137 <a href="http://silcnet.org"><img src="box.gif" border="0" alt="">SILC Project Website</a><br />
138 <a href="http://silcnet.org/support/documentation/"><img src="box.gif" border="0" alt="">SILC Protocol Documentation</a><br />
139 <a href="http://silcnet.org/support/documentation/wp/"><img src="box.gif" border="0" alt="">SILC White Paper</a><br />
140 <a href="http://silcnet.org/support/faq/"><img src="box.gif" border="0" alt="">SILC FAQs</a><br />
141
142 </small>
143 <br /><br /><br /><br />
144     </td></tr>
145    </table>
146   </td>
147
148   <td bgcolor="#cccccc" background="dot.gif">
149    <img src="space.gif" width="1" height="1" border="0" alt=""></td>
150
151   <td width="720" bgcolor="#ffffff">
152    <img src="space.gif" width="1" height="1" border="0" alt="">
153    <table cellpadding="2" cellspacing="6" width="100%">
154     <tr><td valign="top">
155 <br />
156
157 <FONT SIZE="+2" COLOR="#000055"><B><A NAME="SILC_STR_*_NSTRING">SILC_STR_*_NSTRING</A></FONT></B><BR><BR>
158
159 <FONT SIZE="+1"><B>
160 <FONT COLOR="#000055">NAME
161 </FONT></B></FONT>
162 <PRE><FONT FACE="courier" size="3">
163     #define SILC_STR_UI8_NSTRING() ...
164     #define SILC_STR_UI8_NSTRING_ALLOC() ...
165     #define SILC_STR_UI16_NSTRING() ...
166     #define SILC_STR_UI16_NSTRING_ALLOC() ...
167     #define SILC_STR_UI32_NSTRING() ...
168     #define SILC_STR_UI32_NSTRING_ALLOC() ...
169
170 </FONT></PRE><FONT SIZE="+1"><B>
171 <FONT COLOR="#000055">DESCRIPTION
172 </FONT></B></FONT>
173 <PRE><FONT FACE="Helvetiva,Arial,Sans-serif">
174     Unsigned string. Second argument is the length of the string.
175
176     Formatting:    SILC_STR_UI32_NSTRING(unsigned char *, <A HREF="silctypes-SilcUInt32.html">SilcUInt32</A>)
177     Unformatting:  SILC_STR_UI32_NSTRING(unsigned char **, <A HREF="silctypes-SilcUInt32.html">SilcUInt32</A> *)
178
179     Unformatting procedure will check for length of the string from the
180     buffer before trying to get the string out. Thus, one *must* format the
181     length as UI_INT or UI_SHORT into the buffer *before* formatting the
182     actual string to the buffer, and, in unformatting one must ignore the
183     length of the string because unformatting procedure will take it
184     automatically.
185
186      Example:
187
188      Formatting:    ..., SILC_STR_UI_INT(strlen(string)),
189                          SILC_STR_UI32_NSTRING(string, strlen(string)), ...
190      Unformatting:  ..., SILC_STR_UI32_NSTRING(&amp;string, &amp;len), ...
191
192     I.e., you can ignore the formatted length field in unformatting. The
193     length taken from the buffer is returned to the pointer sent as
194     argument (&amp;len in above example).
195
196     UI8, UI16 and UI32 means that the length is considered to be
197     either char (8 bits), short (16 bits) or int (32 bits) in
198     unformatting.
199
200     _ALLOC routines automatically allocates memory for the variable sent
201     as argument in unformatting.
202
203 </FONT></PRE>
204 <br /><br /><br /><br />
205     </td></tr>
206    </table>
207   </td>
208
209   <td bgcolor="#cccccc" background="dot.gif">
210    <img src="space.gif" width="1" height="1" border="0" alt=""></td>
211
212   <td width="180" bgcolor="#f0f0f0">
213     <img src="space.gif" width="1" height="1" border="0" alt="">
214     <table width="100%" cellpadding="4" cellspacing="0">
215     <tr valign="top"><td>
216 <br />
217 <font face="Helvetica,Arial,Sans-serif" size="1">
218 <A HREF="silcbuffmt.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC Buffer Format Interface</A><BR>
219 <A HREF="silcbuffmt-SilcBufferFormatFunc.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcBufferFormatFunc</A><BR>
220 <A HREF="silcbuffmt-SilcBufferSFormatFunc.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcBufferSFormatFunc</A><BR>
221 <A HREF="silcbuffmt-SilcBufferUnformatFunc.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcBufferUnformatFunc</A><BR>
222 <A HREF="silcbuffmt-SilcBufferSUnformatFunc.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcBufferSUnformatFunc</A><BR>
223 <A HREF="silcbuffmt-silc_buffer_format.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_format</A><BR>
224 <A HREF="silcbuffmt-silc_buffer_sformat.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_sformat</A><BR>
225 <A HREF="silcbuffmt-silc_buffer_format_vp.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_format_vp</A><BR>
226 <A HREF="silcbuffmt-silc_buffer_sformat_vp.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_sformat_vp</A><BR>
227 <A HREF="silcbuffmt-silc_buffer_unformat.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_unformat</A><BR>
228 <A HREF="silcbuffmt-silc_buffer_sunformat.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_sunformat</A><BR>
229 <A HREF="silcbuffmt-silc_buffer_unformat_vp.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_unformat_vp</A><BR>
230 <A HREF="silcbuffmt-silc_buffer_sunformat_vp.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_sunformat_vp</A><BR>
231 <A HREF="silcbuffmt-silc_buffer_strformat.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_strformat</A><BR>
232 <A HREF="silcbuffmt-silc_buffer_sstrformat.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_buffer_sstrformat</A><BR>
233 <A HREF="silcbuffmt-SilcBufferParamType.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcBufferParamType</A><BR>
234 <A HREF="silcbuffmt-SILC_STR_*_CHAR.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_*_CHAR</A><BR>
235 <A HREF="silcbuffmt-SILC_STR_*_SHORT.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_*_SHORT</A><BR>
236 <A HREF="silcbuffmt-SILC_STR_*_INT.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_*_INT</A><BR>
237 <A HREF="silcbuffmt-SILC_STR_*_INT64.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_*_INT64</A><BR>
238 <A HREF="silcbuffmt-SILC_STR_*_STRING.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_*_STRING</A><BR>
239 <A HREF="silcbuffmt-SILC_STR_*_NSTRING.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_*_NSTRING</A><BR>
240 <A HREF="silcbuffmt-SILC_STR_DATA.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_DATA</A><BR>
241 <A HREF="silcbuffmt-SILC_STR_BUFFER.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_BUFFER</A><BR>
242 <A HREF="silcbuffmt-SILC_STR_FUNC.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_FUNC</A><BR>
243 <A HREF="silcbuffmt-SILC_STR_OFFSET.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_OFFSET</A><BR>
244 <A HREF="silcbuffmt-SILC_STR_ADVANCE.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_ADVANCE</A><BR>
245 <A HREF="silcbuffmt-SILC_STR_END.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STR_END</A><BR>
246 <A HREF="silcbuffmt-SILC_STRFMT_END.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC_STRFMT_END</A><BR>
247 </font>
248
249 <br /><br /><br /><br />
250     </td></tr>
251     </table>
252   </td>
253 </tr>
254 </table>
255
256 <table border="0" cellspacing="0" cellpadding="0" width="100%">
257 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
258 </table>
259 <table border="0" cellspacing="0" cellpadding="6" width="100%">
260  <tr valign="top" bgcolor="#dddddd">
261   <td><small>Copyright &copy; 2001 - 2007 SILC Project<br />
262     <a href="http://silcnet.org">SILC Project Website</a></small></td>
263   <td align="right"><small>
264    <a href="index.html">SILC Toolkit Reference Manual</a><br />
265    <a href="toolkit_index.html">Index</a></small></td>
266    </small></td>
267  </tr>
268 </table>
269
270 </body>
271 </html>