CHAROPTIONS2

Show in webframe

typedef struct _tagCharOptions2
{
   L_UINT uStructSize;
   L_WCHAR * pszCharPlus;
   L_UINT uCharPlusSize;
   L_WCHAR * pszCharFilterPlus;
   L_UINT uCharFilterPlusSize;
   DOC2_CHAR_FILTER CharFilter;
} CHAROPTIONS2, * pCHAROPTIONS2;

The CHAROPTIONS2 structure contains options for selected languages.

Member	Description
uStructSize	Structure size. It should be equal to sizeof(CHAROPTIONS).
pszCharPlus	Individual characters. These characters are added to the set of characters determined by the language selection. The resulting set of characters is called the Language environment. The user is responsible for allocating pszCharPlus to be large enough to hold all the characters and the terminating zero. The size of the buffer (in characters) must be set in pszCharPlus.
uCharPlusSize	Size of pszCharPlus member. The length of the character pointer allocated in pszCharPlus. If this member is set to zero, pszCharPlus is not used.
pszCharFilterPlus	A set of individual characters. The Filter Plus characters broaden or define the filtered set of characters globally or on a per-zone basis. The user is responsible for allocating pszCharFilterPlus to be large enough to hold all the characters and the terminating zero. The size of the buffer (in characters) must be set in pszCharFilterPlus.
uCharFilterPlusSize	Size of pszCharFilterPlus member. The length of the character pointer allocated in pszCharFilterPlus. If this member is set to zero, pszCharFilterPlus is not used.
CharFilter	A Global filter, that is, a Character Set filter to be applied globally, at the page level. If this function is not called by the integrating application after the engine's initialization, the value DOC2_ZONE_CHAR_FILTER_ALL is applied, that is, the Language environment will not be filtered globally. The Global filter setting is applied to all zones with DOC2_ZONE_CHAR_FILTER_DEFAULT in their CharFilter member of the ZONEDATA2 structures.

Comments

pCHAROPTIONS2 is a pointer to a CHAROPTIONS2 structure. If the function parameter type is pCHAROPTIONS2, declare a CHAROPTIONS2 variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pCHAROPTIONS2 variable is necessary only if the program requires a pointer.

This structure is used with the following functions:

L_Doc2SetCharLangsOptions

L_Doc2GetCharLangsOptions