Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ICreateTypeLib::SetHelpFileName method

Sets the name of the Help file.

Syntax


HRESULT SetHelpFileName(
  [in] LPOLESTR szHelpFileName
);

Parameters

szHelpFileName [in]

The name of the Help file for the library.

Return value

This method can return one of these values.

Return codeDescription
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

Requirements

IDL

OaIdl.idl

See also

ICreateTypeLib

 

 

Community Additions

ADD
Show:
© 2015 Microsoft