GetMsgString

ITcEvent

Die Methode GetMsgString gibt den formatierten Meldungsstring für die angefragte Sprache zurück. Intern ruft sie die Methode TcLogFormatter::GetCompleteString des Formatters auf, der zugeordnet wurde, als das Event von einem COM Client ausgegeben wurde, oder durch einen ADS Aufruf an das Objekt TcEventLog des TcEventLoggers.

 

HRESULT GetMsgString([in] long langId, [out,retval] BSTR* msg);

Parameter

langId

[in] Die Sprach-Id der angefragten Sprache. Die gewünschte Sprache sollte mit *LCIDs markiert werden. Die nächste Tabelle zeigt ein Beispiel für einige Sprach-Ids. In der Konfiguration des Event Formatters werden die Sprachen mit der gleichen Sprach-Id gekennzeichnet.

LCID

Beschreibung

1031

Deutsch

1033

US Englisch

1034

Spanisch 

1036

Französisch

msg

[out, retval] Pointer auf ein BSTR String, der den formatierten String für die angefragte Sprache zurückgibt.

Rückgabe Werte

S_OK

Funktion wurde erfolgreich aufgerufen.

E_POINTER

msg war kein gültiger Pointer.

Visual Basic Beispielcode

' get the one and only event logger
Dim evtLogger As TCEVENTLOGGERLib.TcEventLog
Set evtLogger = New TCEVENTLOGGERLib.TcEventLog

' get the most resent active event
Dim evt As TcEvent
Set evt = evtLogger.GetLastEvent

' get the message in English
Dim strMessage As String
strMessage = evt.GetMsgString(1033)
Debug.Print strMessage

Anmerkungen

Die meisten standardisierten Formatter wie der XML basierende Formatter (TcEventFormatter.TcXmlFormatter) werden versuchen, den String für die Standard-Sprache zurückzugeben, falls die angefragte Sprache nicht in der Konfiguration des Formatters existiert.
*LCID: weitere Informationen finden Sie in der MSDN Library.