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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
|
.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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" ''
'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 turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" 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 ".::uuid++ 3"
.TH .::uuid++ 3 "OSSP uuid 1.6.2" "04-Jul-2008" "Universally Unique Identifier"
.\" 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"
\&\fB\s-1OSSP\s0 uuid\fR \- \fBUniversally Unique Identifier\fR (\*(C+ \s-1API\s0)
.SH "VERSION"
.IX Header "VERSION"
\&\s-1OSSP\s0 uuid \s-11.6.2 (04-Jul-2008)\s0
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBuuid++\fR is the \s-1ISO\-\*(C+\s0 language binding of the \fB\s-1OSSP\s0 uuid\fR C \s-1API\s0.
It provides a thin \s-1ISO\-\*(C+\s0 class \fBuuid\fR wrapping the ISO-C \s-1API\s0 type
\&\fBuuid_t\fR.
.SH "APPLICATION PROGRAMMING INTERFACE"
.IX Header "APPLICATION PROGRAMMING INTERFACE"
The \s-1ISO\-\*(C+\s0 Application Programming Interface (\s-1API\s0) of \fB\s-1OSSP\s0 uuid\fR
consists of the following components:
.Sh "\s-1CONSTANTS\s0"
.IX Subsection "CONSTANTS"
The constants are the same to those provided by the ISO-C \s-1API\s0.
See \fIuuid\fR\|(3) for details.
.Sh "\s-1CLASSES\s0"
.IX Subsection "CLASSES"
The following classes are provided:
.IP "\fBuuid\fR" 4
.IX Item "uuid"
This is the class corresponding to the C \s-1API\s0 type \fBuuid_t\fR.
It is the main object.
.IP "\fBuuid_error_t\fR" 4
.IX Item "uuid_error_t"
This is the class corresponding to the C \s-1API\s0 function \fBuuid_error\fR.
It is the object thrown as an exception in case of any errors.
.Sh "\s-1METHODS\s0"
.IX Subsection "METHODS"
The following methods are provided:
.IP "\fBuuid\fR();" 4
.IX Item "uuid();"
The standard constructor.
.IP "\fBuuid\fR(const uuid &_obj);" 4
.IX Item "uuid(const uuid &_obj);"
The copy constructor for \fBuuid\fR class.
.IP "\fBuuid\fR(const uuid_t *_obj);" 4
.IX Item "uuid(const uuid_t *_obj);"
The import constructor for C \s-1API\s0 objects.
.IP "\fBuuid\fR(const void *_bin);" 4
.IX Item "uuid(const void *_bin);"
The import constructor for binary representation.
.IP "\fBuuid\fR(const char *_str);" 4
.IX Item "uuid(const char *_str);"
The import constructor for string representation.
.IP "~\fBuuid\fR();" 4
.IX Item "~uuid();"
The standard destructor for \fBuuid\fR class.
.IP "uuid &\fBuuid::operator=\fR(const uuid &_obj);" 4
.IX Item "uuid &uuid::operator=(const uuid &_obj);"
The assignment operator corresponding to the copy constructor.
.IP "uuid &\fBuuid::operator=\fR(const uuid_t *_obj);" 4
.IX Item "uuid &uuid::operator=(const uuid_t *_obj);"
The assignment operator corresponding to the import constructor for C \s-1API\s0 objects.
.IP "uuid &\fBuuid::operator=\fR(const void *_bin);" 4
.IX Item "uuid &uuid::operator=(const void *_bin);"
The assignment operator corresponding to the import constructor for binary representation.
.IP "uuid &\fBuuid::operator=\fR(const char *_str);" 4
.IX Item "uuid &uuid::operator=(const char *_str);"
The assignment operator corresponding to the import constructor for string and single integer value representation.
.IP "uuid \fBuuid::clone\fR(void);" 4
.IX Item "uuid uuid::clone(void);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_clone\fR.
.IP "void \fBuuid::load\fR(const char *_name);" 4
.IX Item "void uuid::load(const char *_name);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_load\fR.
.IP "void \fBuuid::make\fR(unsigned int _mode, ...);" 4
.IX Item "void uuid::make(unsigned int _mode, ...);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_make\fR.
.IP "int \fBuuid::isnil\fR(void);" 4
.IX Item "int uuid::isnil(void);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_isnil\fR.
.IP "int \fBuuid::compare\fR(const uuid &_obj);" 4
.IX Item "int uuid::compare(const uuid &_obj);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_compare\fR.
.IP "int \fBuuid::operator==\fR(const uuid &_obj);" 4
.IX Item "int uuid::operator==(const uuid &_obj);"
The comparison operator corresponding to \fBuuid_compare\fR usage for equality.
.IP "int \fBuuid::operator!=\fR(const uuid &_obj);" 4
.IX Item "int uuid::operator!=(const uuid &_obj);"
The comparison operator corresponding to \fBuuid_compare\fR usage for inequality.
.IP "int \fBuuid::operator<\fR(const uuid &_obj);" 4
.IX Item "int uuid::operator<(const uuid &_obj);"
The comparison operator corresponding to \fBuuid_compare\fR usage for less-than.
.IP "int \fBuuid::operator<=\fR(const uuid &_obj);" 4
.IX Item "int uuid::operator<=(const uuid &_obj);"
The comparison operator corresponding to \fBuuid_compare\fR usage for less-than-or-equal.
.IP "int \fBuuid::operator>\fR(const uuid &_obj);" 4
.IX Item "int uuid::operator>(const uuid &_obj);"
The comparison operator corresponding to \fBuuid_compare\fR usage for greater-than.
.IP "int \fBuuid::operator>=\fR(const uuid &_obj);" 4
.IX Item "int uuid::operator>=(const uuid &_obj);"
The comparison operator corresponding to \fBuuid_compare\fR usage for greater-than-or-equal.
.IP "void \fBuuid::import\fR(const void *_bin);" 4
.IX Item "void uuid::import(const void *_bin);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_import\fR for binary representation usage.
.IP "void \fBuuid::import\fR(const char *_str);" 4
.IX Item "void uuid::import(const char *_str);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_import\fR for string representation usage.
.IP "void *\fBuuid::binary\fR(void);" 4
.IX Item "void *uuid::binary(void);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_export\fR for binary representation usage.
.IP "char *\fBuuid::string\fR(void);" 4
.IX Item "char *uuid::string(void);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_export\fR for string representation usage.
.IP "char *\fBuuid::integer\fR(void);" 4
.IX Item "char *uuid::integer(void);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_export\fR for single integer value representation usage.
.IP "char *\fBuuid::summary\fR(void);" 4
.IX Item "char *uuid::summary(void);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_export\fR for textual summary representation usage.
.IP "unsigned long \fBuuid::version\fR(void);" 4
.IX Item "unsigned long uuid::version(void);"
Regular method corresponding to the C \s-1API\s0 function \fBuuid_version\fR.
.IP "\fBuuid_error_t\fR()" 4
.IX Item "uuid_error_t()"
The standard constructor for \fBuuid_error_t\fR class.
.IP "\fBuuid_error_t\fR(uuid_rc_t _code)" 4
.IX Item "uuid_error_t(uuid_rc_t _code)"
The standard constructor for \fBuuid_error_t\fR class with return code initialization.
.IP "~\fBuuid_error_t\fR()" 4
.IX Item "~uuid_error_t()"
The standard destructor for \fBuuid_error_t\fR class.
.IP "void \fBuuid_error_t::code\fR(uuid_rc_t _code)" 4
.IX Item "void uuid_error_t::code(uuid_rc_t _code)"
Regular method for setting the return code.
.IP "uuid_rc_t \fBuuid_error_t::code\fR(void)" 4
.IX Item "uuid_rc_t uuid_error_t::code(void)"
Regular method for fetching the return code.
.IP "char *\fBuuid_error_t::string\fR(void)" 4
.IX Item "char *uuid_error_t::string(void)"
Regular method for fetching the string corresponding to the current return code.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
The following shows an example usage of the \*(C+ \s-1API\s0. Exception handling is
omitted for code simplification and has to be re-added for production
code.
.PP
.Vb 5
\& /* generate a DCE 1.1 v1 UUID from system environment */
\& char *uuid_v1(void)
\& {
\& uuid id;
\& char *str;
\&
\& id.make(UUID_MAKE_V1);
\& str = id.string();
\& return str;
\& }
\&
\& /* generate a DCE 1.1 v3 UUID from an URL */
\& char *uuid_v3(const char *url)
\& {
\& uuid id;
\& uuid id_ns;
\& char *str;
\&
\& id_ns.load("ns:URL");
\& id.make(UUID_MAKE_V3, &id_ns, url);
\& str = id.string();
\& return str;
\& }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIuuid\fR\|(3).
|