CHAROPTIONS

Show in webframe

typedef struct _tagCharOptions
{
   L_UINT uStructSize;
   L_WCHAR * pszCharPlus;
   L_UINT uCharPlusSize;
   L_WCHAR * pszCharFilterPlus;
   L_UINT uCharFilterPlusSize;
   CHAR_FILTER CharFilter;
} CHAROPTIONS,* pCHAROPTIONS;

The CHAROPTIONS structure contains options for selected languages.

Member	Description
uStructSize	Specifies the structure size. It should be equal to sizeof(CHAROPTIONS).
pszCharPlus	Specifies some 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 uCharPlusSize.
uCharPlusSize	Specifies the 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	Specifies 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 uCharFilterPlusSize.
uCharFilterPlusSize	Specifies the 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	Specifies a Global filter, i.e. a Character Set filter to be applied globally, at page level. If this function is not called by the integrating application after the engine's initialization, the value ZONE_CHAR_FILTER_ALL is applied, i.e. the Language environment will not be filtered globally. The Global filter setting is applied to all zones with ZONE_CHAR_FILTER_DEFAULT in their CharFilter member of ZONEDATA structures.

Comments

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

This structure is used with the following functions:

L_DocSetCharLangsOptions

L_DocGetCharLangsOptions