cciLogW

Diese Funktion protokolliert einen Fehler, eine Warnung oder ein informatives Ereignis. Das Ereignis wird von der Schnittstelle des Nachrichtenbrokers mit den angegebenen Argumenten als Protokolldaten protokolliert.

Syntax

void cciLogW(
  int*                        returnCode,
  CCI_LOG_TYPE  type,
  const char*       file,
  int                 line,
  const char*       function,
  const CciChar*    messageSource,
  int                 messageNumber,
  const CciChar*    traceText,
                    ...
);

Parameter

returnCode
Der Rückkehrcode aus der Funktion (Ausgabe). Wenn der Parameter 'messageSource' null ist, wird 'returnCode' auf CCI_INV_DATA_POINTER gesetzt.
type
Der Ereignistyp, der durch CCI_LOG_TYPE definiert wird (Eingabe). Gültige Werte sind:
  • CCI_LOG_ERROR
  • CCI_LOG_WARNING
  • CCI_LOG_INFORMATION
file
Der Name der Quellendatei, von der aus die Funktion aufgerufen wurde (Eingabe). Der Wert ist optional, er ist jedoch für die Fehlerbehebung hilfreich.
line
Die Zeilennummer der Quellendatei, von der aus die Funktion aufgerufen wurde (Eingabe). Der Wert ist optional, er ist jedoch für die Fehlerbehebung hilfreich.
function
Der Name der Funktion, die die Protokollfunktion aufgerufen hat (Eingabe). Der Wert ist optional, er ist jedoch für die Fehlerbehebung hilfreich.
messageSource
Eine Zeichenfolge, die die Windows-Nachrichtenquelle oder den Linux- und UNIX-Nachrichtenkatalog angibt.
messageNumber
Die Nachrichtennummer, die das Ereignis identifiziert (Eingabe). Wenn für messageNumber null angegeben wird, wird vorausgesetzt, dass keine Nachricht verfügbar ist. Wenn messageNumber ungleich null ist, wird die angegebene Nachricht mit Einfügungen, die in der Variablenargumentenliste (siehe unten) angegeben sind, in das Ereignisprotokoll des Brokers geschrieben.
traceText
Trace-Informationen, die in das Traceprotokoll des Broker-Services geschrieben werden (Eingabe). Die Informationen sind optional, sie sind jedoch für die Fehlerbehebung hilfreich.
...
Eine C-Variablenargumentenliste, die Nachrichteneinfügungen enthält, die der Nachricht beigefügt sind (Eingabe). Diese Einfügungen werden als Zeichenfolgen behandelt, und es wird vorausgesetzt, dass die Variablenargumente vom Typ pointer to CciChar sind.
Anmerkung: Das letzte Argument in dieser Liste muss (CciChar*)0 sein.

Rückgabewerte

Keine. Wenn ein Fehler auftritt, gibt der Parameter returnCode die Fehlerursache an.

Beispiel

void logSomethingWithBroker(CciChar* helpfulText, 
                            char*               file,
                            int                 line,
                            char* func 
                            ){
  int          rc = CCI_SUCCESS;
  /* set up the message catalog name */
  const CciChar* catalog = CciString("BIPv600", BIP_DEF_COMP_CCSID);

  cciLogW(&rc,
          CCI_LOG_INFORMATION          file, line, func,
          catalog, BIP2111,
          helpfulText,
          helpfulText,
          (CciChar*)0 
          );     
  
  if(CCI_SUCCESS != rc){
    const CciChar* message = CciString("Failed to log message",
                                       BIP_DEF_COMP_CCSID);
    raiseExceptionWithBroker(message, 
                             __FILE__, 
                             __LINE__, 
                             "logSomethingWithBroker");
  }   
} 
Zugehörige Konzepte
Benutzerdefinierte Erweiterungen
Bemerkungen | Marken | Downloads | Bibliothek | Unterstützung | Rückmeldung
Copyright IBM Corporation 1999, 2006 Letzte Aktualisierung: 23. Aug. 2006
as24570_