Funzione FaxGetLoggingCategoriesW (winfax.h)

Articolo
11/20/2024

La funzione FaxGetLoggingCategories restituisce a un'applicazione client fax le categorie di registrazione correnti per il server fax a cui è connesso il client. Una categoria di registrazione determina gli errori o altri eventi registrati dal server fax nel registro eventi dell'applicazione.

Sintassi

WINFAXAPI BOOL FaxGetLoggingCategoriesW(
  [in]  HANDLE             FaxHandle,
  [out] PFAX_LOG_CATEGORYW *Categories,
  [out] LPDWORD            NumberCategories
);

Parametri

[in] FaxHandle

Tipo: HANDLE

Specifica un handle del server fax restituito da una chiamata alla funzione FaxConnectFaxServer.

[out] Categories

Tipo: PFAX_LOG_CATEGORY*

Puntatore all'indirizzo di un buffer per ricevere una matrice di strutture FAX_LOG_CATEGORY. Ogni struttura descrive una categoria di registrazione corrente. I dati includono il nome descrittivo della categoria di registrazione, il numero di categoria e il livello di registrazione corrente.

Per una descrizione delle categorie di registrazione e dei livelli di registrazione predefiniti, vedere l'argomento FAX_LOG_CATEGORY. Per informazioni sull'allocazione di memoria, vedere la sezione Osservazioni seguenti.

[out] NumberCategories

Tipo: LPDWORD

Puntatore a una variabile DWORD per ricevere il numero di strutture FAX_LOG_CATEGORY restituite dalla funzione nel parametro Categories.

Valore restituito

Tipo: bool

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per ottenere informazioni estese sull'errore, chiamare GetLastError. GetLastError può restituire uno degli errori seguenti.

Codice restituito	Descrizione
ERROR_ACCESS_DENIED	Accesso negato. FAX_CONFIG_QUERY è necessario l'accesso.
ERROR_INVALID_PARAMETER	Uno o tutti i parametriCategories , NumberCategorieso FaxHandle sono NULL.
ERROR_NOT_ENOUGH_MEMORY	Si è verificato un errore durante l'allocazione della memoria.

Osservazioni

Un'applicazione client fax chiama in genere la funzione FaxGetLoggingCategories per eseguire una query sulle categorie di registrazione e sui livelli di registrazione correnti per un server fax. Per modificare le categorie e i livelli di registrazione correnti, chiamare la funzione FaxSetLoggingCategories.

La funzione FaxGetLoggingCategories alloca la memoria necessaria per la matrice di buffer FAX_LOG_CATEGORY a cui punta il parametro Categories . Un'applicazione deve chiamare la funzione faxFreeBuffer per deallocare le risorse associate a questo parametro.

Per altre informazioni, vedere Gestione delle categorie di registrazione e liberare risorse fax.

Nota

L'intestazione winfax.h definisce FaxGetLoggingCategories come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

Requisito	Valore
client minimo supportato	Windows 2000 Professional [solo app desktop]
server minimo supportato	Windows 2000 Server [solo app desktop]
piattaforma di destinazione	Finestre
intestazione	winfax.h
libreria	WinFax.lib