FaxGetDeviceStatus

The FaxGetDeviceStatus function returns to a fax client application current status information for the fax device of interest. The returned data includes, among other items, device and station identifiers, sender and recipient names, and routing information.

BOOL WINAPI FaxGetDeviceStatus(
  HANDLE FaxPortHandle,  // fax port handle
  PFAX_DEVICE_STATUS *DeviceStatus
                         // structure to receive fax device data
);

Parameters

FaxPortHandle

[in] Specifies a fax port handle returned by a call to the FaxOpenPort function.

DeviceStatus

[out] Pointer to the address of a buffer to receive a FAX_DEVICE_STATUS structure. The structure describes the status of one fax device. For information about memory allocation, see the following Remarks section.

Return Values

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.

Remarks

A fax administration application typically calls the FaxGetDeviceStatus function to display the status of a fax device associated with a fax server. The FaxGetDeviceStatus function allocates the memory required for the FAX_DEVICE_STATUS buffer pointed to by the DeviceStatus parameter. An application must call the FaxFreeBuffer function to deallocate the resources associated with this parameter.

For more information, see Fax Device Management and Freeing Fax Resources.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable with BackOffice Small Business Server.
  Header: Declared in Winfax.h.
  Library: Included as a resource in Winfax.dll.
  Unicode: Implemented as Unicode and ANSI versions on all platforms.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Functions, FaxOpenPort, FaxFreeBuffer, FAX_DEVICE_STATUS