Funzione SetupWriteTextLog (setupapi.h)

Articolo
08/26/2023

La funzione SetupWriteTextLog scrive una voce di log in un log di testo SetupAPI.

Sintassi

WINSETUPAPI VOID SetupWriteTextLog(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        Flags,
  [in] PCSTR        MessageStr,
       ...          
);

Parametri

[in] LogToken

Token di log che è un token di log definito dal sistema o che è stato restituito da SetupGetThreadLogToken.

[in] Category

Valore tipizzato DWORD che indica la categoria di eventi per la voce di log. Le categorie di eventi che è possibile specificare per una voce di log corrispondono a quelle che possono essere abilitate per un log di testo. Per un elenco delle categorie di eventi, vedere Abilitazione delle categorie di eventi per un log di testo SetupAPI.

[in] Flags

Valore tipizzato DWORD che è un OR bit per bit dei valori di flag, che specificano quanto segue:

Livello di evento per la voce di log. I livelli di evento che è possibile specificare per una voce di log corrispondono a quelli che possono essere abilitati per un log di testo. Per un elenco dei flag a livello di evento, vedere Impostazione del livello di evento per un log di testo SetupAPI.
Indica se includere un timestamp nella voce di log. Il valore del flag timestamp è TXTLOG_TIMESTAMP.
La modifica, se presente, alla profondità di rientro della sezione e alla voce di log corrente. Per informazioni su come usare i flag di rientro, vedere Scrittura di voci di log rientrate.

[in] MessageStr

Puntatore a una stringa costante con terminazione NULL contenente una stringa di formato compatibile con printf, che specifica il messaggio formattato da includere nella voce di log. L'elenco di parametri delimitati da virgole che segue MessageStr deve corrispondere agli identificatori di formato nella stringa di formato.

...

Elenco di parametri delimitati da virgole che corrisponde agli identificatori di formato nella stringa di formato fornita da MessageStr.

Valore restituito

nessuno

Osservazioni

Se il valore di LogToken è stato restituito da una chiamata a SetupGetThreadLogToken e la sezione del log di testo corrispondente è reperibile, SetupWriteTextLog scrive la voce di log in tale sezione del log di testo. Se SetupWriteTextLog non riesce a individuare la sezione, SetupWriteTextLog scrive la voce di log nel log di testo corrispondente, ma non include la voce di log in una sezione.

Se il valore di LogToken è uno dei token di log definiti dal sistema elencati nella tabella seguente, SetupWriteTextLog esegue l'operazione di scrittura indicata per tale token di log.

Token di log definito dal sistema	Operazione di scrittura
LOGTOKEN_NOLOG	La voce di log non viene scritta in alcun log di testo.
LOG_TOKEN_UNSPECIFIED	La voce di log viene scritta nel log di testo dell'installazione dell'applicazione. La voce di log non è inclusa in una sezione del log di testo.
LOGTOKEN_SETUPAPI_APPLOG	La voce di log viene scritta nel log di testo dell'installazione dell'applicazione. La voce di log non è inclusa in una sezione del log di testo.
LOGTOKEN_SETUPAPI_DEVLOG	La voce di log viene scritta nel log di testo dell'installazione del dispositivo. La voce di log non è inclusa in una sezione del log di testo.

Nota L'impostazione del valore di LogToken su uno dei token di log definiti dal sistema non modifica il valore del token di log corrente per il thread.

Inoltre , SetupWriteTextLog non scrive una voce di log quando una delle condizioni seguenti è vera:

Il livello di evento impostato per il log di testo è minore del livello di evento specificato per la voce di log.
La categoria di eventi per la voce di log non è abilitata per il log di testo. Per altre informazioni sulle categorie di eventi, vedere Abilitazione delle categorie di eventi per un log di testo.

La lunghezza massima, in caratteri, di una voce di log è 336.

Per scrivere informazioni su un errore specifico di SetupAPI o un errore Win32 in un log di testo, un'applicazione può usare SetupWriteTextLogError.

Per informazioni generali sulla scrittura di voci di log nei log di testo SetupAPI, vedere SetupAPI Logging (Windows Vista and Later).

Per altre informazioni sull'operazione di SetupWriteTextLog, vedere Calling SetupWriteTextLog.For more information about the operation of SetupWriteTextLog, see Calling SetupWriteTextLog.

Per altre informazioni sui token di log, vedere Token di log.

Per altre informazioni sull'uso dei token di log, vedere Impostazione e recupero di un token di log per un thread.

Requisiti

Requisito	Valore
Client minimo supportato	Disponibile in Windows Vista e versioni successive di Windows.
Piattaforma di destinazione	Desktop
Intestazione	setupapi.h (include Setupapi.h)
Libreria	Setupapi.lib
Set di API	ext-ms-win-setupapi-logging-l1-1-0 (introdotto in Windows 8)

Vedi anche

SetupGetThreadLogToken

SetupWriteTextLogError

Condividi tramite