formZ SDK | 5.0 API Reference | System | Data Type

# fz_type_get_uchar

Description

This function performs the following data type conversions:
Variant Type Conversion
fzrt_boolean TRUE -> 1; FALSE -> 0.
char bits copied, value < 0 wrap to range of 128 to 255.
short value clamped to range of 0 to 255.
unsigned short value clamped to range of 0 to 255.
fzrt_int value clamped to range of 0 to 255.
fzrt_unsigned_int value clamped to range of 0 to 255.
float value converted to integer then clamped to range of 0 to 255.
double value converted to integer then clamped to range of 0 to 255.

Plugin Prototype

fzrt_error_td fz_type_get_uchar(

fz_type_ptr | type,
unsigned char * | ucval )

Parameters

type [Input]

A pointer to a variant

ucval [Result]

A pointer to a value to be filled. Must be allocated by the caller.

Availability

5.0.0.0

See Also

fz_type_set_uchar, fz_type_get_uchar_ptr

Function Set

fz_type_fset

Defined in

fz_type_api.h