GUIDELINE

Windows Mobile 6.5
A version of this page is also available for
4/8/2010

This structure contains guideline information.


typedef struct tagGUIDELINE {
  DWORD dwSize;
  DWORD dwLevel;
  DWORD dwIndex;
  DWORD dwStrLen;
  DWORD dwStrOffset;
  DWORD dwPrivateSize;
  DWORD dwPrivateOffset;
} GUIDELINE;

dwSize

Specifies the size of this structure.

dwLevel

Specifies the error level.

The following table shows the possible values for dwLevel.

Value Description

GL_LEVEL_NOGUIDELINE

There is no guideline. If the old guideline is shown, the UI should hide the old guideline.

GL_LEVEL_FATAL

Fatal error occurred. Some data may be lost.

GL_LEVEL _ERROR

Error occurs. The handling may not continue.

GL_LEVEL _WARNING

IME warns the user. An unexpected event occurred, but the IME can continue to handle.

GL_LEVEL _INFORMATION

User information.

dwIndex

Specifies the type of guideline information.

The following table shows the possible values for dwIndex.

Value Description

GL_ID_UNKNOWN

Unknown Error. The application should refer to Error String.

GL_ID_NOMODULE

IME cannot find a needed module.

GL_ID_NODICTIONARY

IME cannot find or recognize the dictionary.

GL_ID_CANNOTSAVE

Dictionary or the statistics data cannot be saved.

GL_ID_NOCONVERT

IME cannot convert any more.

GL_ID_TYPINGERROR

Typing error. IME cannot handle this typing.

GL_ID_TOOMANYSTROKE

There are two many strokes for one character or one clause.

GL_ID_READINGCONFLICT

A reading conflict occurred. For example, some vowels cannot be put together to form one character.

GL_ID_INPUTREADING

IME is accepting reading character input from the user.

GL_ID_INPUTRADICAL

IME is accepting radical character input from the user.

GL_ID_INPUTCODE

IME is accepting character code input from the user.

GL_ID_CHOOSECANIDATE

IME is accepting candidate string selection from the user.

GL_ID_REVERSECONVERSION

The information of reverse conversion can be retrieved using the ImmGetGuideLine(hIMC, GGL_PRIVATE. lpBuf, dwBufLen) function. The information filled in lpBuf is in CANDIDATELIST format.

GL_ID_PRIVATE_FIRST

The identifier which is between GL_ID_PRIVATE_FIRST and GL_ID_PRIVATE_LAST is reserved for the IME. IME can freely use these identifiers for its own GUIDELINE.

GL_ID_PRIVATE_LAST

The identifier which is between GL_ID_PRIVATE_FIRST and GL_ID_PRIVATE_LAST is reserved for the IME. IME can freely use these identifiers for its own GUIDELINE.

dwStrLen

Specifies the length of the string that contains the guideline information.

dwStrOffset

Specifies the offset from the start position of this structure.

dwPrivateSize

Private area in this memory block.

dwPrivateOffset

Offset from the beginning of this structure to the private area.

Headerimm.h
Windows Embedded CEWindows CE .NET 4.0 and later
Windows MobileWindows Mobile Version 5.0 and later

Community Additions

Show: