GetCompleteString
Die Methode GetCompleteString gibt den formatierten Meldungsstring der angefragten Sprache zurück. Diese Methode wird von der TcEvent Objekt Methode ITcEvent::GetMsgString aufgerufen.
HRESULTGetCompleteString([in]long nEventId,
[in]long nSrcId,
[in] langId,
[in] TcEventHeader* pEventHead,
[in] SAFEARRAY(VARIANT)* eventData,
[out, retval] BSTR* msg)
Parameter
nEventId
[in] Variable, die die Event Id darstellt.
nSrcId
[in] Variable, die die Source Id darstellt.
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 |
pEventHead
[in] Pointer auf ein Objekt vom Typ TcEventHeader. Das Objekt stellt die Eventkonfiguration dar.
eventData
[in] Pointer auf ein Safearray, das die Event Argumente darstellt. In der Konfiguration des Event Formatters ist definiert, wie die Event Argumente in der angezeigten Event Meldung platziert werden.
Die folgenden Datentypen werden von Standard Formatter unterstützt:
int (16bit), long (32bit), float(32bit), double(64bit), string(BSTR). Die Eventdaten werden zugeordnet, wenn das Event ausgegeben wird.
msg
[out, retval] PPointer auf einen BSTR String der den formatierten String für die angefragte Sprache zurückgibt
Rückgabe Werte
S_OK
Funktion wurde erfolgreich aufgerufen.
E_POINTER
szFormat war kein gültiger Pointer.
E_NOTIMPL
Die Methode ist nicht implementiert.
Anmerkungen
Die meisten Standard Formatter, wie der XML basierende Formatter (TcEventFormatter.TcXmlFormatter), versuchen, einen String für die Default-Sprache zurückzugeben, falls die angefragte Sprache nicht in der Konfiguration des Formatters existiert.
*LCID: weitere Informationen finden Sie in der MSDN Library.