Funzione FaxGetConfigurationW (winfax.h)

Articolo
11/20/2024

La funzione FaxGetConfiguration restituisce a un'applicazione client fax le impostazioni di configurazione globali per il server fax a cui è connesso il client. I dati includono, tra gli altri elementi, ritrasmissione, personalizzazione, archivio e impostazioni della pagina di copertina; periodi di tasso di sconto; e lo stato della coda del server fax.

Sintassi

WINFAXAPI BOOL FaxGetConfigurationW(
  [in]  HANDLE              FaxHandle,
  [out] PFAX_CONFIGURATIONW *FaxConfig
);

Parametri

[in] FaxHandle

Tipo: HANDLE

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

[out] FaxConfig

Tipo: PFAX_CONFIGURATION*

Puntatore all'indirizzo di un buffer per ricevere una struttura FAX_CONFIGURATION. La struttura contiene le impostazioni di configurazione correnti per il server fax. Per informazioni sull'allocazione di memoria, vedere la sezione Osservazioni seguenti.

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_INVALID_PARAMETER	Uno o entrambi i parametri FaxConfig o FaxHandle sono NULL.
ERROR_ACCESS_DENIED	Accesso negato. FAX_CONFIG_QUERY è necessario l'accesso.
ERROR_NOT_ENOUGH_MEMORY	Si è verificato un errore durante l'allocazione della memoria.

Osservazioni

Un'applicazione di amministrazione fax chiama in genere la funzione FaxGetConfiguration per visualizzare le impostazioni di configurazione globali per il server fax. Per modificare le impostazioni di configurazione, chiamare la funzione faxSetConfiguration .

La funzione FaxGetConfiguration alloca la memoria necessaria per il buffer FAX_CONFIGURATION a cui punta il parametro FaxConfig . Un'applicazione deve chiamare la funzione faxFreeBuffer per deallocare le risorse associate a questo parametro.

Per altre informazioni, vedere gestione della configurazione del server fax e liberare risorse fax.

Nota

L'intestazione winfax.h definisce FaxGetConfiguration 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