UniSetUconvObject

UniSetUconvObject

UniSetUconvObject(uconvObj, uconvAttr)

Set the attributes of a conversion object.

Parameters

uconvObj - UconvObject - input

The conversion object created from UniCreateUconvObject.

uconvAttr - uconv_attribute_t - input

The conversion object attributes.

options

options

Substitution options can be:

• UCONV_OPTION_SUBSTITUTION_BOTH
• UCONV_OPTION_SUBSTITUTION_FROM_UNICODE
• UCONV_OPTION_SUBSTITUTION_TO_UNICODE

endian

Source and target endian. Source applies to UniUconvFromUcs; target applies to UniUconvToUcs.

• 0x000 Use system endian.
• 0xfeff Use big endian.
• 0xffff Use little endian.

displaymask

32 bit display and data mask. Each bit represents a control character below space (1<<char). The bit being a zero the character represents a glyph. The bit being one the character represents a control.

• DSPMASK_CRLF
• DSPMASK_DATA
• DSPMASK_DISPLAY

converttype

Conversion flags which can be ORed together.

• CVTTYPE_CDRA
• CVTTYPE_CTRL7F
• CVTTYPE_PATH

subchar_len

Code page substitution length whose value is from 1 to and including 13. A value of 0 the substitution character from the conversion table should be used.

subchar

Substitution bytes.

subuni_len

Unicode substitution length whose value can be 0 or 1. A value of 0 the Unicode substitution should come from the conversion table.

subuni

If subuni_len is 1, the first element is the Unicode substitution character.

state

When set to 0, the conversion object is put into its base conversion state.

Returns

An integer with values of:

• UCONV_EINVAL
• ULS_SUCCESS

Calling conversion

Cdecl32

Example Code

UconvObject       uconvObj;
uconv_attribute_t uconvAttr;
integer           rc;
...
rc = UniSetUconvObject(uconvObj, uconvAttr);
...

Related Functions

UniCreateUconvObject UniFreeUconvObject UniQueryUconvObject

Notes

UniSetUconvObject sets the attributes of the conversion object. The given attributes are used to modify the default conversion. It is left up to each conversion to decide which attributes it will recognize.

The substitution character attribute specifies to the conversion object what to do when this is no identical character for a given code element.

OS Version Introduced

OS/2 Warp