IActiveIMMIME::GetGuideLineA Method

Retrieves information about errors. Applications can use this information to notify users. ANSI implementation.

Syntax

HRESULT GetGuideLineA(
    HIMC hIMC,
    DWORD dwIndex,
    DWORD dwBufLen,
    LPSTR pBuf,
    DWORD *pdwResult
);

Parameters

hIMC

[in] Handle to the input context.

dwIndex

[in] Unsigned long integer value that contains the guideline information to retrieve.

dwBufLen

[in] Unsigned long integer value that contains the size, in bytes, of the buffer referenced by pBuf.

pBuf

[out] Address of a string value that receives the error message string.

pdwResult

[out] Address of an unsigned long integer value that receives the error level, error index, or size of an error message string, depending on the value of dwIndex. If dwBufLen is set to zero, pdwResult receives the buffer size, in bytes, needed to receive the requested information.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

This method maps to the ImmGetGuideLine function documented in the Microsoft® Platform Software Development Kit (SDK).