Skip to content

Latest commit

 

History

History
141 lines (116 loc) · 3.29 KB

nf-oaidl-icreatetypelib-sethelpfilename.md

File metadata and controls

141 lines (116 loc) · 3.29 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:oaidl.ICreateTypeLib.SetHelpFileName
ICreateTypeLib::SetHelpFileName (oaidl.h)
Sets the name of the Help file.
ICreateTypeLib interface [Automation]
SetHelpFileName method
ICreateTypeLib.SetHelpFileName
ICreateTypeLib::SetHelpFileName
SetHelpFileName
SetHelpFileName method [Automation]
SetHelpFileName method [Automation]
ICreateTypeLib interface
_oa96_ICreateTypeLib_SetHelpFileName
automat.icreatetypelib_sethelpfilename
oaidl/ICreateTypeLib::SetHelpFileName
automat\icreatetypelib_sethelpfilename.htm
automat
a9dc11b0-1483-4272-84cb-4f885f6cff6f
12/05/2018
ICreateTypeLib interface [Automation],SetHelpFileName method, ICreateTypeLib.SetHelpFileName, ICreateTypeLib::SetHelpFileName, SetHelpFileName, SetHelpFileName method [Automation], SetHelpFileName method [Automation],ICreateTypeLib interface, _oa96_ICreateTypeLib_SetHelpFileName, automat.icreatetypelib_sethelpfilename, oaidl/ICreateTypeLib::SetHelpFileName
oaidl.h
Windows
OaIdl.idl
Windows
19H1
ICreateTypeLib::SetHelpFileName
oaidl/ICreateTypeLib::SetHelpFileName
c++
APIRef
kbSyntax
COM
oaidl.h
ICreateTypeLib.SetHelpFileName

ICreateTypeLib::SetHelpFileName

-description

Sets the name of the Help file.

-parameters

-param szHelpFileName [in]

The name of the Help file for the library.

-returns

This method can return one of these values.

Return code Description
S_OK
Success.
E_INVALIDARG
One or more of the arguments is not valid.
E_OUTOFMEMORY
Insufficient memory to complete the operation.
STG_E_INSUFFICIENTMEMORY
Insufficient memory to complete the operation.
TYPE_E_INVALIDSTATE
The state of the type library is not valid for this operation.

-remarks

Each type library can reference a single Help file.

The GetDocumentation method of the created ITypeLib returns a fully qualified path for the Help file, which is formed by appending the name passed into szHelpFileName to the registered Help directory for the type library. The Help directory is registered under:

\TYPELIB<guid of library><Major.Minor version >\HELPDIR

-see-also

ICreateTypeLib