ifx_gl_case_conv_outbuflen - calculates an approximation of the number of bytes for multi-byte case conversion

SYNOPSIS

#include <ifxgls.h>
int ifx_gl_case_conv_outbuflen(int src_mbs_bytes);

DESCRIPTION

This function calculates either exactly the number of bytes that will be required by a buffer of case-equivalent multi-byte characters or a close over-approximation of the number. The argument src_mbs_bytes is the number of bytes in the buffer of multi-byte characters to be case converted. This buffer can contain one or more multi-byte characters. This function applies to both upper-case and lower-case conversions.

If the value returned by this function is not equal to src_mb_bytes, then case conversion of multi-byte characters cannot be done in-place. A separate multi-byte destination buffer must be allocated. However, if the value returned by this function is exactly equal to src_mb_bytes, then multi-byte case conversion can be done in-place.

This function does not apply to wide-character case conversions.

RETURN VALUES

If a buffer of one or more multi-byte characters contains src_mb_bytes bytes, then this function returns the number of bytes required to store the those multi-byte characters after they have either been converted to lower-case or upper-case characters.

ERRORS

None

SEE ALSO

ifx_gl_tomupper(), ifx_gl_tomlower(),

ACKNOWLEDGEMENT

Portions of this description were derived from the X/Open CAE Specification: "System Interfaces and Headers, Issue 4"; X/Open Document Number: C202; ISBN: 1-872630-47-2; Published by X/Open Company Ltd., U.K.