2.2.45 FAX_PORT_INFO_EXW

  • Article

The FAX_PORT_INFO_EXW structure defines information about a single fax device, known as a port. This structure is used for FAX_SetPortEx (section 3.1.4.1.89).

 typedef struct {
   DWORD dwSizeOfStruct;
   DWORD dwDeviceID;
   [string] LPCWSTR lpcwstrDeviceName;
   [string] LPWSTR lpwstrDescription;
   [string] LPCWSTR lpcwstrProviderName;
   [string] LPCWSTR lpcwstrProviderGUID;
   BOOL bSend;
   FAX_ENUM_DEVICE_RECEIVE_MODE ReceiveMode;
   DWORD dwStatus;
   DWORD dwRings;
   [string] LPWSTR lpwstrCsid;
   [string] LPWSTR lpwstrTsid;
 } FAX_PORT_INFO_EXW,
  *PFAX_PORT_INFO_EXW;

dwSizeOfStruct: DWORD ([MS-DTYP] section 2.2.9) value that holds the total size of the structure, in bytes. This value MUST be 48 or 72 bytes. When filled in on a 32-bit implementation, this value SHOULD be 48 bytes. When filled in on a 64-bit implementation, this value SHOULD be 72 bytes.

dwDeviceID: A DWORD that holds the line identifier for the specified fax device (port).

lpcwstrDeviceName: A null-terminated character string that holds the name of the fax device.

lpwstrDescription: A null-terminated character string that holds the description of the fax device. The length of this string MUST NOT exceed MAX_FAX_STRING_LEN (section 2.2.86) characters, including the length of the terminating null character.

lpcwstrProviderName: A null-terminated character string that holds the name of the fax device provider.

lpcwstrProviderGUID: A null-terminated character string that holds the GUID of the fax device provider.

bSend: A Boolean value that indicates whether the fax device is enabled to send faxes.

ReceiveMode: An FAX_ENUM_DEVICE_RECEIVE_MODE (section 2.2.55) enumeration value that indicates whether the fax device is enabled to receive faxes and whether the calls are manually or automatically answered.

dwStatus: A DWORD that holds the current status of the device. It SHOULD contain any combination of values from the FAX_ENUM_DEVICE_STATUS (section 2.2.64) enumeration or 0 (meaning: status unknown).

dwRings: A DWORD that holds the number of times an incoming fax call rings before the specified device answers the call.

lpwstrCsid: A null-terminated character string that holds the called subscriber identifier for faxes sent using this device. This identifier can be a telephone number.

lpwstrTsid: A null-terminated character string that holds the transmitting subscriber identifier for faxes sent using this device. This identifier can be a telephone number.