ICreateErrorInfo::SetHelpContext

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method sets the Help context identifier for the error.

Syntax

HRESULT SetHelpContext( 
  DWORD dwHelpContext
);

Parameters

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

Return Value

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

Header oaidl.h, oaidl.idl
Library oleaut32.lib, uuid.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

ICreateErrorInfo
ICreateErrorInfo::SetHelpFile