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

# fzrt_fzr_get_string_size

Description

Gets the size of the string This will return the number of bytes needed to store the string, including any terminating or length bytes. This is not the same as the string length. This function is useful if you need to allocated storage before reading the string.

Plugin Prototype

fzrt_error_td fzrt_fzr_get_string_size(

const fzrt_fzr_ref_td | fzr_ref,
fzrt_unsigned_int | list_id,
fzrt_unsigned_int | index,
fzrt_unsigned_int * | size )

Parameters

fzr_ref [Input]

reference to the resource file

list_id [Input]

ID of the string resource in the file

index [Input]

1-based index to the string in the string list

size [Result]

pointer to an unsigned short that receives the number of bytes in the string

Returns

FZRT_NOERR if successful, error ID otherwise.

Availability

5.0.0.0

See Also

fzrt_fzr_open, fzrt_fzr_get_string

Function Set

fz_fzrt_base_fset

Defined in

fzrt_api.h