Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
helpstringcontext
id
in
int
odl
out
ptr
ref
Collapse the table of content
Expand the table of content

helpstringcontext attribute

The [helpstringcontext] attribute specifies a 32-bit Help context identifier in the Help file. You can apply the [helpstringcontext] attribute to library, interface, dispinterface, module, coclass, typedef statements, properties, parameters and methods.


[  helpstringcontext(contextid)[, optional-attribute-list]] idl-statement

Parameters

contextid

A unique integer that identifies the help text associated with the current MIDL statement.

optional-attribute-list

Zero or more MIDL attributes.

idl-statement

The MIDL statement to which the [helpstringcontext] attribute will be applied.

Remarks

Use the GetDocumentation2 functions in the ITypeLib2 and ITypeInfo2 interfaces to retrieve the help string.

Examples

[
    uuid(. . .),
    helpstringcontext(103),
    version(1.0)
]
library Lines
{
    [
        uuid(. . .), 
        helpstringcontext(102),
        oleautomation,
        dual
    ]
    interface ILine : IDispatch
    {
        [propget, helpstringcontext(100)] HRESULT Color([out, retval] long* ReturnVal); 
        [propput, helpstringcontext(101)] HRESULT Color([in] long rgb);
    }
};

 

 

Community Additions

ADD
Show:
© 2015 Microsoft