Syntax

    #include <pexports.h>
    
    UINT32 RegisterHealthMonitor (
      UINT32   moduleHandle,
      UINT32  *handle,
      UINT8    category,
      UINT8    flags,
      char    *descriptionString,
      char    *URL,
      char    *helpURL,
      char    *oldDescriptionString);
    

Parameters

moduleHandle

(IN) Specifies the NLM handle that is passed to you at startup. The handle is used for resource tracking at unload time.

handle

(OUT) Points to a handle that is used to identify your health monitor when you unregister it or post health status.

category

(IN) Specifies the type monitor so that like monitors can be grouped together in the list of health monitors. For available categories, see Section 6.7, Categories.

flags

(IN) Specifies whether or not this is a new health monitor or if you are replacing one that is already there. It can also indicate that you want your page to be displayed in the full browser window.

The following values are supported:

Value	Flag
0x01	NEW_ENTRY
0x02	REPLACE_ENTRY
0x04	FULL_PAGE_DISPLAY (Requires Portal 1.1)

descriptionString

(IN) Points to a string that will be displayed in the chart under the Description heading. This is the string that has a link to your more detailed information. If the description is a NULL and the oldDescriptionString matches the current description, the description stays the same.

URL

(IN) Points to a URL that points to your more detailed information when the user clicks on your Description string. It needs to be the full URL for your page.

helpURL

(IN) Points to the URL for your specific Health Help information, when the user clicks on your question mark icon for specific information. It needs to be the full URL for your help page.

oldDescriptionString

(IN) Points to the description string for the health monitor that you desire to replace. It is only valid when the flags parameter is set to REPLACE_ENTRY.

Return Values

If successful, returns 0. Otherwise, returns a nonzero error code. See Section 6.6, Health Monitor Error Codes.

Remarks

The RegisterHealthMonitor function allows any NLM running on the server to register with the Portal NLM to indicate that they are monitoring something and would like to report its state. Each item registered receives a handle back, which is used to post a health status and to unregister the health monitor. Each registered health monitor is required to have a URL, help URL, description string flags, and a category.