Port Name Properties

Property Description
BAUD

Specifies the baud rate for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. Default is the last port setting. Possible values are:

  • "110"

  • "300"

  • "600"

  • "1200"

  • "2400"

  • "4800"

  • "9600"

  • "14400"

  • "19200"

  • "38400"

  • "57600"

  • "115200"

  • "128000"

  • "256000"

BtRetries

Number of times to retry a Bluetooth Open if an error 55 is received. Use with WPPORT transport type.

You will occasionally receive an error 55 ("The specified network resource or device is no longer available") when you open a Bluetooth channel. This setting allows you to have the LinePrinter automatically retry the connection a set number of times if an error 55 occurs.

CTS

Specifies how the CTS (clear-to-send) line will be used for hardware handshaking for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. CTS defaults to the last port setting.

Possible values are:

  • "Y" or "y": The CTS signal is monitored for output flow control.

  • "N" or "n": The CTS signal is ignored.

DATABITS

Specifies the number of data bits sent per byte for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. Value is usually 7 or 8, with 8 being most common. Defaults to the last port setting.

DSR

Specifies how the DSR (data-set-ready) line will be used for hardware handshaking for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. DSR defaults to the last port setting.

Possible values are:

  • "Y" or "y": The DSR signal is monitored for output flow control.

  • "N" or "n": The DSR signal is ignored.

DTR

Specifies how the DTR line will be used for hardware handshaking for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. DTR defaults to the last port setting and may be one of the following values:

  • "Y": Disables the DTR line when the device is opened and leaves it disabled.

  • "N": Enables the DTR line when the device is opened and leaves it on.

  • "H": Enables DTR handshaking.

PARITY

Specifies the parity bit usage for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. PARITY defaults to the last port setting and may be one of the following values:

  • "N": No parity.

  • "O": Odd parity.

  • "E": Even parity.

  • "M": Mark parity.

  • "S": Space parity.

PORT

Specifies the virtual serial port used for NPCP and Bluetooth communications. Use with WPPORT and NPCP transport types.

This setting applies to the computer only and should be set to match the settings currently on the printer.  For NPCP, this should be the serial port that the NPCP driver is associated with (typically "COM1:").

STOPBITS

Specifies the stop bits usage for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. STOPBITS defaults to the last port setting and may be one of the following values:

  • "1"

  • "1.5"

  • "2"

XONXOFF

Specifies whether software handshaking should be used for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. XONXOFF defaults to the last port setting and may be one of the following values:

  • "Y" or "y": Specifies that XON/XOFF flow control is used during transmission. Transmission stops when the XoffChar character is received and starts again when the XonChar character is received.

  • "N" or "n": Specifies that XON/XOFF flow control is ignored.

RTS

Specifies how the RTS line is used for hardware handshaking for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer. RTS defaults to the last port setting and may be one of the following values:

  • "Y": Enables the RTS line when the device is opened and leaves it on.

  • "N": Disables the RTS line when the device is opened and leaves it disabled.

  • "H": Enables RTS handshaking. The driver raises the RTS line when the "type-ahead" (input) buffer is less than one-half full and lowers the RTS line when the buffer is more than three-quarters full.

  • "T": Specifies that the RTS line will be high if bytes are available for transmission. After all buffered bytes have been sent, the RTS line will be low.

ReadIntervalTimeout

The maximum time allowed to elapse between the arrival of two bytes on the communications line for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

During a read operation, the time period begins when the first byte is received. If the interval between the arrival of any two bytes exceeds this amount, the read operation is completed and any buffered data is returned. A value of zero indicates that interval time-outs are not used.

This setting applies to the computer only and should be set to match the settings currently on the printer. ReadIntervalTimeout defaults to the last port setting.

A value of MAXDWORD, combined with zero values for both the ReadTotalTimeoutConstant and ReadTotalTimeoutMultiplier members, specifies that the read operation is to return immediately with the bytes that have already been received, even if no bytes have been received.

ReadTotalTimeoutConstant

A constant used to calculate the total time-out period for read operations, in milliseconds, for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

For each read operation, this value is added to the product of the ReadTotalTimeoutMultiplier member and the requested number of bytes.

This setting applies to the computer only and should be set to match the settings currently on the printer. ReadTotalTimeoutConstant defaults to the last port setting.

ReadTotalTimeoutMultiplier

The multiplier used to calculate the total time-out period for read operations, in milliseconds. Use with COMx: (and occasionally with WPPORT) transport type.

For each read operation, this value is multiplied by the requested number of bytes to be read for serial port connections.

This setting applies to the computer only and should be set to match the settings currently on the printer. ReadTotalTimeoutMultiplier defaults to the last port setting.

A value of zero for both the ReadTotalTimeoutMultiplier and ReadTotalTimeoutConstant members indicates that total time-outs are not used for read operations.

WriteTotalTimeoutConstant

A constant used to calculate the total time-out period for write operations, in milliseconds, for serial port connections. Use with COMx: (and occasionally with WPPORT) transport type.

For each write operation, this value is added to the product of the WriteTotalTimeoutMultiplier member and the requested number of bytes.

This setting applies to the computer only and should be set to match the settings currently on the printer. WriteTotalTimeoutConstant defaults to the last port setting.

A value of zero for both the WriteTotalTimeoutMultiplier and WriteTotalTimeoutConstant members indicates that total time-outs are not used for write operations.

WriteTotalTimeoutMultiplier

The multiplier used to calculate the total time-out period for write operations, in milliseconds. Use with COMx: (and occasionally with WPPORT) transport type.

For each write operation, this value is multiplied by the requested number of bytes to be written for serial port connections.

This setting applies to the computer only and should be set to match the settings currently on the printer. WriteTotalTimeoutMultiplier defaults to the last port setting.

A value of zero for both the WriteTotalTimeoutMultiplier and WriteTotalTimeoutConstant members indicates that total time-outs are not used for write operations.

IPADDRESS

IP address of the printer you are connecting to for Wi-Fi printing (for example: IPADDRESS="192.168.112.134"). Use with WIFI transport type.

This setting applies to the computer only and should be set to match the settings currently on the printer.

IPPORT

The network port of the printer to be connected for Wi-Fi printing (for example: IPPORT="515", or IPPORT="9100"). Use with SOCKET and WIFI transport types.

This setting applies to the computer only and should be set to match the settings currently on the printer.

When the transport type is SOCKET, this value may be overidden by the newPort parameter of GetConfiguration, GetStatus, or Open.

ADDRESS

Bluetooth address, IP address, or "IRDA". Specifies the address of the printer (or if IrDA, the first IrDA device discovered) to connect to. Use with SOCKET transport type.

For Bluetooth or Wi-Fi printers, the address must be in the standard format ("xx:xx:xx:xx:xx:xx" for Bluetooth, or "yyy.yyy.yyy.yyy" for Wi-Fi).

For an IrDA connected printer, it must be the string "IRDA".

If portString in the Open (string), Open(string,int), GetStatus(string), GetStatus(string,int), GetConfiguration(string PortString), or GetConfiguration(string, int) methods is specified, it overrides ADDRESS.

BTPIN

Specifies the personal identification number (PIN) used to authenticate the Bluetooth connection. Use with SOCKET transport type when ADDRESS is a Bluetooth address.

If no value is specified, or for an empty string (""), validation is not performed.

If newPort is specified in the GetConfiguration, GetStatus, or Open  methods, it overrides BTPIN.

BTCONNECTRETRYDELAY Specifies the delay (in milliseconds) between attempts to connect to a Bluetooth printer. Use with SOCKET transport type when ADDRESS is a Bluetooth address. Supported when BTCONNECTRETRIES is greater than 1.
BTCONNECTRETRIES Specifies the number of times the computer tries to connect to the Bluetooth printer before throwing an exception. Use with SOCKET transport type when ADDRESS is a Bluetooth address.
BTMAXWRITESIZE

Specifies the maximum size of the largest data chunk to be written in a single write operation. Use with SOCKET transport type when ADDRESS is a Bluetooth address.

The actual size of the packet may be smaller than this value depending on a number of factors. If the data in Write exceeds the maximum packet size, the data is broken down into multiple packets transparent to the method call.

BTMAXREADSIZE

Specifies the largest data chunk to be read in a single read operation. Use with SOCKET transport type when ADDRESS is a Bluetooth address.

If the data being read exceeds the maximum packet size, the data is broken down into multiple packets transparent to the method call.

BTDATAWRITETIMEOUT

Specifies the maximum amount of time (in milliseconds) the computer waits until the printer indicates that it is ready to receive data for the first write attempt. Use with SOCKET transport type when ADDRESS is a Bluetooth address.

If the printer is blocking data from being sent to it, this value is the longest that the computer waits for the printer to be ready to start accepting data. This timeout period applies to each "write" to the printer.

If the computer is able to send data before the timeout expires, it does so and then returns. Thus, if the printer is not blocking data, making this value larger does not affect the time it takes to send data to the printer.

BTWRITEINTERVALTIMEOUT

Specifies the maximum amount of time (in milliseconds) the computer waits until the printer indicates it is ready to receive data after the first write attempt. Use with SOCKET transport type when ADDRESS is a Bluetooth address.

If the printer starts to block the receipt of data being sent after data has begun to be transferred, this value is the maximum amount of time the computer waits for the printer to begin accepting data again. This timeout period applies to each "write" to the printer.

If the computer is able to send data before the timeout expires, it does so and then returns. Thus, if the printer is not blocking data, making this value larger does not affect the time it takes to send data to the printer.

BTREADINTERVALTIMEOUT

Specifies the maximum amount of time (in milliseconds) that the computer waits to receive data from the printer after it has started to receive data from the printer. Use with SOCKET transport type when ADDRESS is a Bluetooth address.

This property is also known as intercharacter gap. If the printer stops sending data, the value is the maximum amount of time the computer waits for the printer to resume sending data. This timeout period applies to each "read" of the printer.

If this timeout is exceeded, it is assumed that the printer has completed sending data to the computer.

IPCONNECTRETRYDELAY Specifies the delay (in milliseconds) between attempts to connect to a Wi-Fi printer. Use with SOCKET transport type when ADDRESS is an IP address format. Supported when BTCONNECTRETRIES is greater than 1.
IPCONNECTRETRIES Specifies the number of times the computer tries to connect to the Wi-Fi printer before throwing an exception. Use with SOCKET transport type when ADDRESS is an IP address format.
IPMAXWRITESIZE

Specifies the maximum size of the largest data chunk to be written in a single write operation. Use with SOCKET transport type when ADDRESS is an IP address format.

The actual size of the packet may be smaller than this value depending on a number of factors. If the data in Write exceeds the maximum packet size, the data is broken down into multiple packets transparent to the method call.

IPMAXREADSIZE

Specifies the largest data chunk to be read in a single read operation. Use with SOCKET transport type when ADDRESS is an IP address format.

The actual packet size may be smaller depending on a number of factors. If the data being read exceeds the maximum packet size, the data is broken down into multiple packets transparent to the method call.

IPDATAWRITETIMEOUT

Specifies the maximum amount of time (in milliseconds) the computer waits until the printer indicates that it is ready to receive data for the first write attempt. Use with SOCKET transport type when ADDRESS is an IP address format.

If the printer is blocking data from being sent to it, this value is the longest that the computer waits for the printer to be ready to start accepting data. This timeout period applies to each "write" to the printer.

If the computer is able to send data before the timeout expires, it does so and then returns. Thus, if the printer is not blocking data, making this value larger does not affect the time it takes to send data to the printer.

IPWRITEINTERVALTIMEOUT

Specifies the maximum amount of time (in milliseconds) that the computer waits until the printer indicates it is ready to receive data after the first write attempt. Use with SOCKET transport type when ADDRESS is an IP address format.

If the printer starts to block the receipt of data being sent after data has begun to be transferred, this value is the maximum amount of time the computer waits for the printer to begin accepting data again. This timeout period applies to each "write" to the printer.

If the computer is able to send data before the timeout expires, it does so and then returns. Thus, if the printer is not blocking data, making this value larger does not affect the time it takes to send data to the printer.

IPREADINTERVALTIMEOUT

Specifies the maximum amount of time (in milliseconds) that the computer waits to receive data from the printer after it has started to receive data from the printer. Use with SOCKET transport type when ADDRESS is an IP address format.

This property is also known as intercharacter gap. If the printer stops sending data, the value is the maximum amount of time the computer waits for the printer to resume sending data. This timeout period applies to each "read" of the printer.

If this timeout is exceeded, it is assumed that the printer has completed sending data to the computer.

IRServiceName

Specifies the service name of the IrDA printer to be connected. Use with SOCKET transport type when ADDRESS is the string "IRDA".

Typically, this value is "IrDA:lrCOMM" or "LSAP-SEL002".

IRModelRLMP

IrDA interface level for the IrDA printer to be connected. Use with SOCKET transport type when ADDRESS is the string "IRDA".

Typically, this value is 22 or 21 decimal.

If newPort is specified in the GetConfiguration, GetStatus, or Open  methods, it overrides IRModelRLMP.

IRCONNECTRETRYDELAY Specifies the delay (in milliseconds) between attempts to connect to an IrDA printer. Use with SOCKET transport type when ADDRESS is the string "IRDA". Supported when BTCONNECTRETRIES is greater than 1.
IRCONNECTRETRIES Specifies the number of times the computer tries to connect to the IrDA printer before throwing an exception. Use with SOCKET transport type when ADDRESS is the string "IRDA".
IRDISCOVERYRETRIES

Specifies the number of times the computer tries to discover IrDA devices before it throws an exception. Use with SOCKET transport type when ADDRESS is the string "IRDA".

Before the computer can connect to an IrDA printer, the computer must first attempt to discover the available IrDA printers. This value sets the number of discovery retries.

IRDISCOVERYDELAY Specifies the delay (in milliseconds) between IrDA discovery attempts. Use with SOCKET transport type when ADDRESS is the string "IRDA".
IRMAXWRITESIZE

Specifies the maximum size of the largest data chunk to be written in a single write operation. Use with SOCKET transport type when ADDRESS is the string "IRDA".

The actual size of the packet may be smaller than this value depending on a number of factors. If the data in Write exceeds the maximum packet size, the data is broken down into multiple packets transparent to the method call.

IRMAXREADSIZE

Specifies the largest data chunk to be read in a single read operation. Use with SOCKET transport type when ADDRESS is the string "IRDA".

The actual packet size may be smaller depending on a number of factors. If the data being read exceeds the maximum packet size, the data is broken down into multiple packets transparent to the method call.

IRDATAWRITETIMEOUT

Specifies the maximum amount of time (in milliseconds) the computer waits until the printer indicates that it is ready to receive data for the first write attempt. Use with SOCKET transport type when ADDRESS is the string "IRDA".

If the printer is blocking data from being sent to it, this value is the longest that the computer waits for the printer to be ready to start accepting data. This timeout period applies to each "write" to the printer.

If the computer is able to send data before the timeout expires, it does so and then returns. Thus, if the printer is not blocking data, making this value larger does not affect the time it takes to send data to the printer.

IRWRITEINTERVALTIMEOUT

Specifies the maximum amount of time (in milliseconds) that the computer waits until the printer indicates it is ready to receive data after the first write attempt. Use with SOCKET transport type when ADDRESS is the string "IRDA".

If the printer starts to block the receipt of data being sent after data has begun to be transferred, this value is the maximum amount of time the computer waits for the printer to begin accepting data again. This timeout period applies to each "write" to the printer.

If the computer is able to send data before the timeout expires, it does so and then returns. Thus, if the printer is not blocking data, making this value larger does not affect the time it takes to send data to the printer.

IRREADINTERVALTIMEOUT

Specifies the maximum amount of time (in milliseconds) that the computer waits to receive data from the printer after it has started to receive data from the printer. Use with SOCKET transport type when ADDRESS is the string "IRDA".

This property is also known as intercharacter gap. If the printer stops sending data, the value is the maximum amount of time the computer waits for the printer to resume sending data. This timeout period applies to each "read" of the printer.

If this timeout is exceeded, it is assumed that the printer has completed sending data to the computer.