EnumDocLinks

This method returns an enum object that is used to repeat listed events. DocLinks are path and filename of the documents, like HTML pages, that are used to descripe the Event in the given language.
This method is called from the TcEvent object method  ITcEvent::EnumDocLinks.

HRESULTEnumDocLinks([in]long nEventId,
                    [in]long nSrcId,
                    [in] langId,
                    [out, retval] ITcEnumEventDocLink ** ppEnum
)

Parameter

nEventId

[in] Variable with the Event Id.

nSrcId

[in] Variable with the Source Id.

langId

[in] The language id of the needed language. The needed language should be marked with *LCIDs. The following table gives a list of some language ids.

LCID

Description

1031

German

1033

US English

1034

Spanish

1036

French

ppEnum

[out, retval] Pointer to a ITcEnumEventDocLink pointer that gets the enum object

Return Values

S_OK

Function successful.

E_POINTER

ppEnum was an invalid pointer.

Notes

*LCID: more information in the MSDN Library.

 

See also