SetFormatString

ITcLogFormatterC

This method returns the Format string assigned from TcEvent.DataFormatStrAddress when the object returned from the PLC module ADSLOGEVENT was shown.

HRESULT SetFormatString([in]long nEventId,
                       [in]long nSrcId,
                       [in] langId,
                       [in] BSTR * szFormatString)

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

msg

[in] a  BSTR string with the Format string

Return Values

S_OK

Function successful.

E_NOTIMPL

This method is not implemented.

 

Notes

The TcXmlFormatter does not support this method.

*LCID: more information in the MSDN Library.