Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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

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

Example

Copy Code
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