ICreateErrorInfo::SetHelpContext

This method sets the Help context identifier for the error.

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

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Oaidl.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.