API per scrivere messaggi di log

Introduzione

Le API descritte di seguito generano messaggi di log e sono fornite dalla classe C# statica Log.

Se i messaggi sono generati da Q Studio a design time o a runtime da una Q Application in esecuzione su un target connesso, tali messaggi sono visualizzabili in Q Studio nel pannello dei log (vedere Interfaccia di Q Studio). La categoria del messaggio (argomento category disponibile in alcune API) è anch’essa visualizzabile in Q Studio nel pannello dei log, nella colonna Categoria.

Log.Debug(message)

Genera il messaggio di debug passato come argomento.

static void Debug(string message);

Argomenti

message string

Messaggio da generare.

Esempio

Log.Debug("This is a debug message");

Log.Debug(category, message)

Genera il messaggio di debug passato come secondo argomento e vi associa la categoria passata come primo argomento.

static void Debug(string category, string message);

Argomenti

category string

Categoria del messaggio.

message string

Messaggio da generare.

Esempio

Log.Debug("CustomCategory", "This is a debug message");

Log.Error(message)

Genera il messaggio di errore passato come argomento.

static void Error(string message);

Argomenti

message string

Messaggio da generare.

Esempio

Log.Error("This is an error message");

Log.Error(category, message)

Genera il messaggio di errore passato come secondo argomento e vi associa la categoria passata come primo argomento.

static void Error(string category, string message);

Argomenti

message string

Messaggio da generare.

Esempio

Log.Error("CustomCategory", "This is an error message");

Log.Info(message)

Genera il messaggio informativo passato come argomento.

static void Info(string message);

Argomenti

message string

Messaggio da generare.

Esempi

Log.Info("This is an info message");

Log.Info(category, message)

Genera il messaggio informativo passato come secondo argomento e vi associa la categoria passata come primo argomento.

static void Info(string category, string message);

Argomenti

message string

Messaggio da generare.

Esempi

Log.Info("CustomCategory", "This is an info message");

Log.Node(node, verbose)

Restituisce una stringa che contiene il percorso del nodo passato come argomento. Il secondo argomento, opzionale, abilita/disabilita l’inserimento del NodeId e del tipo di oggetto nella stringa restituita.

static string Node(IUANode node, bool verbose);

Argomenti

node IUANode

Nodo di cui si vuole generare il percorso in formato stringa

verbose bool

false (default) = non inserisce informazioni aggiuntive nella stringa restituita.

true = inserisce NodeId e tipo di oggetto nella stringa restituita.

Restituisce

string

Percorso del nodo passato come argomento. In base al valore dell’argomento verbose, può contenere anche il NodeId e il tipo di oggetto.

Esempi

Di seguito un esempio in cui l’API Log.Info genera un messaggio composto dalla stringa «Error on node » e dal percorso del NetLogic, restituito come stringa dall’API Log.Node:

Log.Info("Error on node " + Log.Node(LogicObject);

Log.Warning(message)

Genera il messaggio di avvertimento passato come argomento.

static void Warning(string message);

Argomenti

message string

Messaggio da generare.

Esempio

Log.Warning("This is a warning message");

Log.Warning(category, message)

Genera il messaggio di avvertimento passato come secondo argomento e vi associa la categoria passata come primo argomento.

static void Warning(string category, string message);

Argomenti

message string

Messaggio da generare.

Esempio

Log.Warning("CustomCategory", "This is a warning message");