EnumDocLinks

ITcEvent

Returns an enumeration object that is used to iterate through the list of document links. Document links are the path and file name to documents like HTML pages and pictures that could give more detailed information about one alarm for the chosen language. Internally EnumDocLinks is referred to the formatter method ITcLogFormatter::EnumDocLinks. The document links must be setup in the formatter configuration of the event.

HRESULTEnumDocLinks([in] long langId,
                    [out,retval] IUnknown** ppEnum
);

Parameters

langId

[in] The language Id of the requested language. The requested language should be tagged by *LCIDs. The next table shows a sample for some language ids. In the configuration of the event formatter the language are tagged by the same language id

LCID

Description

1031

German

1033

US English

1034

Spanish - Spain

1036

French

 

ppEnum

[out, retval] Pointer to the ITcEnumEventDocLink interface pointer that receives the enumeration object of the document links.

Return Values

S_OK

Function was successfully called

E_POINTER

ppEnum was no valid pointer.

Remarks

The Method does not work in Visual Basic