uconv_object (UconvObject) - input

The conversion object created by a call to UniCreateUconvObject.

attr_t (uconv_attribute_t *) - input

uconv_attribute_t lets the caller set the values of the conversion object attributes. The caller can set these fields:

options

Substitution options, which can have one of these values:

UCONV_OPTION_SUBSTITUTION_BOTH UCONV_OPTION_SUBSTITUTION_FROM_UNICODE
UCONV_OPTION_SUBSTITUTION_TO_UNICODE

endian
Source and target endian. This is a structure containing a source and target endian field. Source applies to UniUconvFromUcs; target applies to UniUconvToUcs. Each of the fields can contain one of the following values:

0x000

Use system endian.
0xfeff
Use big endian.
0xfffe
Use little endian.
displaymask
A 32-bit display and data mask. Each bit represents a control character below space (1<<char). If the bit is 0, the character is treated as a display glyph. If the bit is 1, the character is treated as a control. There are several predefined values for this mask, but any value can be used:

DSPMASK_CRLF

CR and LF are controls: Others are glyphs.
DSPMASK_DATA
All characters less than space are controls.
DSPMASK_DISPLAY
All characters less than space are glyphs.
converttype
Conversion type. This is a set of flags. The following flags exist and can be ORed together:

CVTTYPE_CDRA

Use IBM standard control conversion. If this bit is not set, controls are converted to an equal value. Some conversions always do control conversions.
CVTTYPE_CTRL7F
Treat the 0x7f character as a control.
CVTTYPE_PATH
When performing Unicode conversions, strings are assumed to contain path names. This setting is only applicable when converting to or from DBCS code pages.
subchar_len
Code page substitution length. This can be a value between 1 and 13 to indicate the substitution length. It may not exceed the maximum size character in the encoding. A value of zero indicates that the substitution character from the conversion table should be used.
subchar
Substitution bytes. This is the actual value whose length is specified by subchar_len.
subuni_len
Unicode substitution length. This can be either 0 or 1. A zero indicates that the Unicode substitution from the conversion table should be used.
subuni
If subuni_len is set to 1, the first element in this array gives the Unicode substitution character.
state
When the state is set to 0, the conversion object is put into the base conversion state.

result (int) - returns

UCONV_EINVAL

Indicates a parameter is not valid.
ULS_SUCCESS
Indicates success.
For a full list of error codes and the decimal and hexadecimal values of the error codes, see Error Codes.

---

[Back: UniSetUconvObject Return Value - result]
[Next: UniSetUconvObject - Remarks]