.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ici::doc::pod3::sdrstring 3"
.TH ici::doc::pod3::sdrstring 3 "2016-07-07" "perl v5.24.1" "ICI library functions"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
sdrstring \- Simple Data Recorder string functions
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    #include "sdr.h"
\&
\&    Object sdr_string_create (Sdr sdr, char *from);
\&    Object sdr_string_dup    (Sdr sdr, Object from);
\&    int    sdr_string_length (Sdr sdr, Object string);
\&    int    sdr_string_read   (Sdr sdr, char *into, Object string);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1SDR\s0 strings are used to record strings of up to 255 \s-1ASCII\s0 characters
in the heap space of an \s-1SDR. \s0 Unlike standard C strings, which are terminated
by a zero byte, \s-1SDR\s0 strings record the length of the string as
part of the string object.
.PP
To store strings longer than 255 characters, use \fIsdr_malloc()\fR and \fIsdr_write()\fR
instead of these functions.
.IP "Object sdr_string_create(Sdr sdr, char *from)" 4
.IX Item "Object sdr_string_create(Sdr sdr, char *from)"
Creates a \*(L"self-delimited string\*(R" in the heap of the
indicated \s-1SDR,\s0 allocating the required space and copying the
indicated content.  \fIfrom\fR must be a standard C
string for which \fIstrlen()\fR must not exceed 255; if
it does, or if insufficient \s-1SDR\s0 space is available, 0
is returned.  Otherwise the address of the newly created \s-1SDR\s0
string object is returned.  To destroy, just use \fIsdr_free()\fR.
.IP "Object sdr_string_dup(Sdr sdr, Object from)" 4
.IX Item "Object sdr_string_dup(Sdr sdr, Object from)"
Creates a duplicate of the \s-1SDR\s0 string whose address is
\&\fIfrom\fR, allocating the required space and copying the
original string's content.  If insufficient \s-1SDR\s0 space is
available, 0 is returned.  Otherwise the address of the newly
created copy of the original \s-1SDR\s0 string object is returned.  To
destroy, use \fIsdr_free()\fR.
.IP "int sdr_string_length(Sdr sdr, Object string)" 4
.IX Item "int sdr_string_length(Sdr sdr, Object string)"
Returns the length of the indicated self-delimited string (as would
be returned by \fIstrlen()\fR), or \-1 on any error.
.IP "int sdr_string_read(Sdr sdr, char *into, Object string)" 4
.IX Item "int sdr_string_read(Sdr sdr, char *into, Object string)"
Retrieves the content of the indicated self-delimited string into
memory as a standard C string (\s-1NULL\s0 terminated).  Length of \fIinto\fR
should normally be \s-1SDRSTRING_BUFSZ \s0(i.e., 256) to allow for the largest
possible \s-1SDR\s0 string (255 characters) plus the terminating \s-1NULL. \s0 Returns
length of string (as would be returned by \fIstrlen()\fR), or \-1 on any error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIsdr\fR\|(3), \fIsdrlist\fR\|(3), \fIsdrtable\fR\|(3), \fIstring\fR\|(3)