IActiveIMMApp::GetGuideLineA method

Gets information about errors. Applications use this information to notify users (ANSI implementation).

Syntax

HRESULT GetGuideLineA(
  [in]  HIMC  hIMC,
  [in]  DWORD dwIndex,
  [in]  DWORD dwBufLen,
  [out] LPSTR pBuf,
  [out] DWORD *pdwResult
);

Parameters

• hIMC [in]
  A handle to the input context.

• dwIndex [in]
  An unsigned long integer value that contains the guideline information to get.

• dwBufLen [in]
  An unsigned long integer value that contains the size, in bytes, of the buffer that is referenced by pBuf.

• pBuf [out]
  The address of a string value that receives the error message string.

• pdwResult [out]
  The 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, that is required to receive the requested information.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method maps to the ImmGetGuideLine function that is documented in the Windows Software Development Kit (SDK).

Requirements

See also

IActiveIMMApp