helpcontext attribute
The [helpcontext] attribute specifies a context identifier that lets the user view information about this element in the Help file.
[
uuid(uuid-number),
helpcontext(helpcontext-value)
[, attribute-list]
]
element element-name
{
definitions
}
Parameters
-
uuid-number
-
Specifies a universally unique identification number for the library, [importlib], interface, dispinterface, module, typedef, methods, [property], or coclass.
-
helpcontext-value
-
A unique integer that identifies the help text associated with the current MIDL element.
-
attribute-list
-
Specifies a list of one or more attributes that apply to the MIDL element as a whole.
-
element
-
One of the following directives: library, [importlib], interface, dispinterface, module, typedef, method, property, or coclass.
-
element-name
-
The name that other software components can use to delineate the current element.
-
definitions
-
Specifies statements that make up the element definition.
Remarks
The [helpcontext] attribute can be applied to the following elements: library, [importlib], interface, dispinterface, module, typedef, method, property, or coclass.
The helpcontext-value is a 32-bit context identifier within the Help file that can be retrieved with the GetDocumentation functions in the ITypeLib and ITypeInfo interfaces.
Examples
[
uuid(1e196b20-1f3c-1069-996b-00dd010fe676),
helpcontext(7035943),
helpstring("Hello Class"),
appobject
]
coclass Hello
{
[default, helpcontext(3914972)] interface IHello : IUnknown;
interface IDispatch;
}
See also