formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | Basic

# fzrt_UUID_to_string

Description

Creates an ascii string for a UUID. Two string format options are available: Traditional : "{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}" formZ : "\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX\xXX" where X is a hexadecimal digit. A traditional string will be created if traditional is set to TRUE.
Traditional strings are the most common way to present a UUID in a human readable form. formZ strings are used to set UUIDs to variables in formZ plugins and scripts.

Plugin Prototype

fzrt_error_td fzrt_UUID_to_string(

const fzrt_UUID_td | uuid,
fzrt_boolean | traditional,
char * | str,
fzrt_int | max_len )

Parameters

uuid [Input]

The UUID to convert

traditional [Input]

String format indicator

str [Result]

The created UUID string

max_len [Input]

The maximum length (in bytes) of the UUID string

Returns

FZRT_NOERR on success.
FZ_BAD_PARAMETER_ERROR - str or uuid is NULL.

Availability

5.0.0.0

See Also

, fzrt_UUID_td,

Function Set

fz_fzrt_base_fset

Defined in

fzpl_uuid_type.h