How can I add some help/guide line string in the definition of a method to help client to understand the functionality of the method?

The helpstring is an optional attribute to describe the different IDL objects. Helpstring can be given to these IDL objects like-

1. Interface
2. Methods and properties
3. CoClasses
4. Type libraries

[
  uuid(34A715A0-6587-11D0-924A-0020AFC7AC4D), // IID_DWebBrowserEvents2
  helpstring("Web Browser Control events interface"),
  hidden
]
dispinterface DWebBrowserEvents2
{
properties:
  methods:

  [id(DISPID_PROGRESSCHANGE),
  helpstring("Fired when download progress is updated."), helpcontext(0x0000)]

  void ProgressChange([in] long Progress, [in] long ProgressMax);

  [id(DISPID_DOWNLOADCOMPLETE),
  helpstring("Download of page complete."), helpcontext(0x0000)]

  void DownloadComplete();

  [id(DISPID_DOWNLOADBEGIN),
   helpstring("Download of a page started."), helpcontext(0x000)]
   
  void DownloadBegin();

}
  
[
uuid(0002DF01-0000-0000-C000-000000000046), // CLSID_InternetExplorer
helpstring("Internet Explorer Application."),
]

coclass InternetExplorer
{
  [default]     interface   IWebBrowser2;
  interface   IWebBrowserApp;
  [default, source] dispinterface DWebBrowserEvents2;
  [source]      dispinterface DWebBrowserEvents;
}

Helpstring is to briefly describe the object or to provide an inline help for external world. These helplines are useful for the developers who uses these COM server in their application. These help strings are readable with an object browser such as the one provided with Microsoft Visual Basic.

About our authors: Team EQA

You have viewed 1 page out of 67. Your COM/DCOM learning is 0.00% complete. Login to check your learning progress.

‹ # ›