Skip to content

Latest commit

 

History

History
132 lines (99 loc) · 4.91 KB

nc-winfax-pfaxclose.md

File metadata and controls

132 lines (99 loc) · 4.91 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NC:winfax.PFAXCLOSE
PFAXCLOSE (winfax.h)
The FaxClose function closes fax handles
FaxCloseA
FaxCloseW
PFAXCLOSE
PFAXCLOSE callback
PFAXCLOSE callback function [Fax Service]
_mfax_faxclose
fax._mfax_faxclose
winfax/FaxCloseA
winfax/FaxCloseW
winfax/PFAXCLOSE
fax\_mfax_faxclose.htm
Fax
VS|fax|~\fax\faxlegacy_5h2d.htm
12/05/2018
FaxCloseA, FaxCloseW, PFAXCLOSE, PFAXCLOSE callback, PFAXCLOSE callback function [Fax Service], _mfax_faxclose, fax._mfax_faxclose, winfax/FaxCloseA, winfax/FaxCloseW, winfax/PFAXCLOSE
winfax.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
FaxCloseW (Unicode) and FaxCloseA (ANSI)
Windows
19H1
PFAXCLOSE
winfax/PFAXCLOSE
c++
APIRef
kbSyntax
UserDefined
Winfax.h
PFAXCLOSE
FaxCloseA
FaxCloseW

PFAXCLOSE callback function

-description

The FaxClose function closes the following types of fax handles:

-parameters

-param FaxHandle [in]

Type: HANDLE

Specifies the fax handle to close. This value can be a fax server handle returned by a call to the FaxConnectFaxServer function, or a fax port handle returned by a call to the FaxOpenPort function.

-returns

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can return one of the following errors.

Return code Description
ERROR_ACCESS_DENIED
Access is denied. FAX_PORT_QUERY access is required.
ERROR_INVALID_HANDLE
The FaxHandle parameter is invalid.

-remarks

A fax client application must call the FaxClose function as the last function before it terminates. The CloseHandle function cannot close the handle to a fax server or a fax port.

When the FaxClose function closes a handle allocated by the FaxConnectFaxServer function, the function disconnects the calling application from the specified fax server.

A fax client application continues to receive fax events from the fax service after the application successfully calls the FaxClose function to close a fax server handle. This permits the fax service to shut down and conserve system resources when the service has been idle for an extended period. If you keep the handle to the fax server open, the fax service does not shut down.

For more information, see Enabling an Application to Receive Notifications of Fax Events, Connecting to a Fax Server and Disconnecting from a Fax Server, and FaxInitializeEventQueue.

-see-also

Fax Service Client API Functions

Fax Service Client API for Windows 2000

FaxConnectFaxServer

FaxOpenPort