GetFormatString

This method returns the Formatstring assigned from TcEvent.DataFormatStrAddress when the event was shown by the PLC method ADSLOGEVENT.

HRESULT GetFormatString([in]long nEventId,
                       [in]long nSrcId,
                       [in] langId,
                       [out, retval] BSTR * szFormat)

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

szFormat

[out, retval] Pointer to a BSTR string that returns the format.

Return Values

S_OK

Function successful.

E_POINTER

szFormat was an invalid pointer.

E_NOTIMPL

This method is not implemented.

Notes

The TcXmlFormatter does not support this method.

*LCID: more information in the MSDN Library.