ImGetStatusString

ImGetStatusString

Applications can get a status string.

Format:

APIRET APIENTRY ImGetStatusString(HIMI hIMI, ULONG ulIndex, PVOID pBuf,
                                            PULONG pulBufLen)

Parameters:

hIMI(input)

- a handle of a IMInstance
ulIndex(input)
- index of information to query

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_STATUS_STRING             │Status string. Output is a 0-terminated string.   │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_STATUS_STRINGATTR         │Attribute of the status string                    │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_STATUS_CURSORPOS          │Cursor position. Output is ULONG value.           │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_STATUS_CURSORATTR         │Cursor attribute. Output is ULONG value.          │
└──────────────────────────────┴──────────────────────────────────────────────────┘

Status string attributes are,

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│SP_STRING_REVERSED            │The text will be drawn in reversed color.         │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│SP_STRING_UNDERSCORE          │The text will be drawn with underscore.           │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│SP_STRING_BACKCOLOR           │The text background color will be cyan. (Normally │
│                              │it is white.)                                     │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│SP_STRING_FORECOLOR           │The text foreground color will be red. (Normally  │
│                              │it is black.)                                     │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│SP_STRING_SEPARATOR           │The text will have a separator on right side edge.│
└──────────────────────────────┴──────────────────────────────────────────────────┘

Cursor attributes are,

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│SP_CSR_INSERT                 │The double-sized cursor appears as normal.        │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│SP_CSR_INVISIBLE              │Cursor is invisible.                              │
└──────────────────────────────┴──────────────────────────────────────────────────┘

pBuf(output)
- a buffer to be copied the information into
pulBufLen(input/output)
- (input)size, in bytes, of the buffer
(output)actual size of data copied to the buffer. If 0 is input in ulBufLen, this gets size of buffer to get full information.

Return:

Zero is successful. Others are errors.