|
ITypeInfo::GetDocumentation
memid, lpbstrName, lpbstrDocString, lpdwHelpContext, lpbstrHelpFile)
MEMBERID memid
BSTR FAR* lpbstrName
BSTR FAR* lpbstrDocString
unsigned long FAR* lpdwHelpContext
BSTR FAR* lpbstrHelpFile
Retrieves the documentation string, name of the complete Help file path and
name, and the context ID for the Help topic for a specified type description.
Parameters
memid
ID of the member whose documentation is to be returned.
lpbstrName
Pointer to a BSTR allocated by the callee into which the name of the specified
item is placed. If the caller does not need the item name, lpbstrName can be NULL.
lpbstrDocString
Pointer to a BSTR into which the documentation string for the specified item
is placed. If the caller does not need the documentation string, lpbstrDocString can be NULL.
lpdwHelpContext
Pointer to the Help context associated with the specified item. If the caller
does not need the Help context, the lpdwHelpContext can be NULL.
lpbstrHelpFile
Pointer to a BSTR into which the fully qualified name of the Help file is
placed. If the caller does not need the Help filename, lpbstrHelpFile can be NULL.
Return Value
The SCODE obtained from the returned HRESULT is one of the following:
SCODE
| Meaning
| S_OK
| Success.
| E_OUTOFMEMORY
| Out of memory.
| E_INVALIDARG
| One or more of the arguments is invalid.
| TYPE_E_IOERROR
| The function could not read from the file.
| TYPE_E_ELEMENTNOTFOUND
| The element was not found.
| TYPE_E_INVDATAREAD
| The function could not read from the file.
| TYPE_E_UNSUPFORMAT
| The type library has an old format.
| TYPE_E_INVALIDSTATE
| The type library could not be opened.
| TYPE_E_ELEMENTNOTFOUND
| The element was not found.
|
Comments
Provides access to the documentation for the member specified by the memid parameter. If the passed-in memid is MEMBERID_NIL, then the documentation for the type description is returned.
If the type description inherits from another type description, this function
recurses on the base type description, if necessary, to find the item with the
requested member ID.
The caller should use SysFreeString() to free the BSTRs referenced by lpbstrName, lpbstrDocString, and lpbstrHelpFile.
Related LinksSoftware for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
TMS Scripter Studio Pro components for Delphi/C++Builder
More Online Helps Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages
|
