ICreateErrorInfo::SetHelpContext

This method sets the Help context identifier for the error.

At a Glance

Header file: Oaidl.h
Windows CE versions: 2.0 and later

Syntax

HRESULT SetHelpContext( DWORD dwHelpContext );

Parameters

dwHelpContext

Specifies the Help context identifier for the error.

Return Values

One of the values described in the following table is returned.

Value Description
S_OK Success.
E_OUTOFMEMORY Insufficient memory to complete the operation.

Remarks

ICreateErrorInfo::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);