ICreateErrorInfo::SetHelpContext

This method sets the Help context identifier for the error.

HRESULT SetHelpContext( 
  DWORD dwHelpContext
);

Parameters

  • dwHelpContext
    [in] Specifies the Help context identifier for the error.

Return Values

If the method succeeds, the return value is S_OK.

If there is insufficient memory to complete the operation, the return value is E_OUTOFMEMORY.

Remarks

SetHelpContext sets the Help context identifier for the error. To establish the Help file to which it applies, use ICreateErrorInfo::SetHelpFile.

Example

hr = CreateErrorInfo(&pcerrinfo);
pcerrinfo->SetHelpContext(dwhelpcontext);

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Oaidl.h, Oaidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.

See Also

ICreateErrorInfo | ICreateErrorInfo::SetHelpFile

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.