Funzione FaxSendDocumentA (winfax.h)

2024-11-20

Un'applicazione client fax chiama la funzione FaxSendDocument per accodare un processo fax che trasmetterà una trasmissione fax in uscita.

Sintassi

WINFAXAPI BOOL FaxSendDocumentA(
  [in]           HANDLE                    FaxHandle,
  [in]           LPCSTR                    FileName,
  [in]           PFAX_JOB_PARAMA           JobParams,
  [in, optional] const FAX_COVERPAGE_INFOA *CoverpageInfo,
  [out]          LPDWORD                   FaxJobId
);

Parametri

[in] FaxHandle

Tipo: HANDLE

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

[in] FileName

Tipo: LPCTSTR

Puntatore a una stringa di caratteri con terminazione Null costante contenente il percorso completo e il nome del file che contiene il documento fax da trasmettere. Il percorso può essere un percorso UNC o un percorso che inizia con una lettera di unità.

Questo parametro può contenere qualsiasi nome di file locale valido. Il file deve essere un tipo di file registrato correttamente e il server fax deve essere in grado di accedere al file.

[in] JobParams

Tipo: PFAX_JOB_PARAM

Puntatore a una struttura FAX_JOB_PARAM che contiene le informazioni necessarie per il server fax per inviare la trasmissione fax. La struttura include, tra gli altri elementi, il numero di fax del destinatario, i dati del mittente e del destinatario, un codice di fatturazione facoltativo e informazioni sulla pianificazione dei processi.

[in, optional] CoverpageInfo

Tipo: const FAX_COVERPAGE_INFO*

Puntatore a una struttura FAX_COVERPAGE_INFO che contiene i dati personali da visualizzare nella pagina di copertina del documento fax. Questo parametro deve essere NULL se non è necessaria una copertina.

[out] FaxJobId

Tipo: LPDWORD

Puntatore a un DWORD variabile per ricevere un numero univoco che identifica il processo in coda che invierà la trasmissione fax.

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 tutti i parametri FaxHandle, JobParamso FileName sono null; L'handle di chiamata specificato dal membro CallHandle della struttura FAX_JOB_PARAM non è valido (deve essere NULL) o il membro RecipientNumber nella struttura FAX_JOB_PARAM è NULL.
ERROR_INVALID_FUNCTION	Il parametro FaxHandle specifica una connessione remota, ma il membro CallHandle della struttura FAX_JOB_PARAM non è NULL.
ERROR_ACCESS_DENIED	Accesso negato. FAX_JOB_SUBMIT è necessario l'accesso.
ERROR_FILE_NOT_FOUND	Il server fax non è in grado di individuare il file specificato dal FileName o dal parametro CoverpageInfo.
ERROR_INVALID_DATA	Il server fax non può elaborare il file specificato dal FileName o dal parametro CoverpageInfo.
ERROR_NOT_SUPPORTED	È stato effettuato un tentativo di consegnare una chiamata vocale per inviare un fax, utilizzando il Membro CallHandle della struttura FAX_JOB_PARAM. Questa funzionalità non è supportata.

Osservazioni

Chiamare la funzione FaxCompleteJobParams prima di chiamare la funzione FaxSendDocument. FaxCompleteJobParams è una funzione di utilità che inserisce più membri nelle strutture FAX_COVERPAGE_INFO e FAX_JOB_PARAM, con informazioni quali il nome del mittente, il numero di fax e le informazioni facoltative sul codice di fatturazione.

La funzione FaxSendDocument viene eseguita in modo asincrono e la funzione restituisce immediatamente. Il server fax accoda il processo per inviare la trasmissione fax in base ai dettagli specificati dalla struttura FAX_JOB_PARAM.

Affinché FaxSendDocument l'esito positivo, è necessario che nel server fax sia installata una stampante fax remota.

Per inviare un documento fax in modo efficiente a più destinatari, un'applicazione deve chiamare la funzione FaxSendDocument più volte. La funzione FaxSendDocumentForBroadcast è supportata per la compatibilità con le versioni precedenti.

Quando si invia un documento da un'applicazione, i collegamenti nel documento possono causare la visualizzazione di una finestra di dialogo che richiede informazioni. Se non si gestisce la richiesta di informazioni entro alcuni minuti, FaxSendDocument avrà esito negativo e restituirà un errore.

Nota

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