libixp

git clone git://oldgit.suckless.org/libixp/
Log | Files | Refs | LICENSE

ixp_pstring.3 (1063B)

      1 .TH "IXP_PSTRING" 3 "2010 Jun" "libixp Manual"
      2 
      3 .SH NAME
      4 .P
      5 ixp_pstring
      6 
      7 .SH SYNOPSIS
      8 .nf
      9   #include <ixp.h>
     10   
     11   void ixp_pstring(IxpMsg *msg, char **s);
     12 .fi
     13 
     14 .SH DESCRIPTION
     15 .P
     16 Packs or unpacks a UTF\-8 encoded string. The packed
     17 representation of the string consists of a 16\-bit unsigned
     18 integer followed by the contents of the string. The unpacked
     19 representation is a nul\-terminated character array.
     20 
     21 .P
     22 If ImsgR\->mode is MsgPack, the string pointed to by IsR is
     23 packed into the buffer at ImsgR\->pos. If ImsgR\->mode is
     24 MsgUnpack, the address pointed to by IsR is loaded with a
     25 malloc(3) allocated, nul\-terminated representation of the
     26 string packed at ImsgR\->pos. In either case, ImsgR\->pos is
     27 advanced by the number of bytes read or written. If the
     28 action would advance ImsgR\->pos beyond ImsgR\->end,
     29 ImsgR\->pos is still advanced but no other action is taken.
     30 
     31 .SH SEE ALSO
     32 .P
     33 IxpMsg(3), ixp_pstrings(3), ixp_pdata(3)
     34 
     35 
     36 .\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
     37 .\" cmdline: txt2tags -o- ixp_pstring.man3
     38