QBConnector Class

Properties Methods Events Config Settings Errors

The QBCONNECTOR class is a utility that allows you to connect your QuickBooks Integrator applications to remote QuickBooks instances.

Class Name

InQB_QBConnector

Procedural Interface

 inqb_qbconnector_open();
 inqb_qbconnector_close($res);
 inqb_qbconnector_register_callback($res, $id, $function);
 inqb_qbconnector_get_last_error($res);
 inqb_qbconnector_get_last_error_code($res);
 inqb_qbconnector_set($res, $id, $index, $value);
 inqb_qbconnector_get($res, $id, $index);
 inqb_qbconnector_do_adduser($res, $user, $password, $qbconnectionstring, $authmode);
 inqb_qbconnector_do_config($res, $configurationstring);
 inqb_qbconnector_do_doevents($res);
 inqb_qbconnector_do_reset($res);
 inqb_qbconnector_do_shutdown($res);

Remarks

The QBConnector class is a lightweight web server which listens for HTTP requests originating from the QuickBooks Integrator classs. Each request sent to the QBConnector by a QuickBooks Integrator class contains the XML data to be communicated to QuickBooks as well as configuration settings specifying how the connection is to be opened. The QBConnector then communicates with QuickBooks via COM, and returns the QuickBooks response (or an error message) in the HTTP reply.

Using the QBConnector class is easy. Simply set Listening to True, and the class will begin listening for incoming messages on the specified LocalPort. The messages will be processed by the QuickBooks application that is running on the same machine as the QBConnector, and the results will automatically be returned to the requesting client.

Basic authentication is enabled by default, meaning the connecting clients must present a user name and password in the QBConnectionString of the class they're using. The supplied user name and password are checked against the list of AuthorizedUsers. If no user in the list matches the supplied credentials, the Authorization event will fire with the Accept parameter set to false. If the user was found in the list of AuthorizedUsers then the parameter will be set to True. You may override this functionality by setting the Accept parameter inside the Authorization event manually. If no "Authorization" header supplied in the request, the Authorization event will fire with blank User and Password parameters.

Note that the AuthorizedUserQBConnectionString will be used to make the connection to QuickBooks for a user found in the AuthorizedUsers collection.

Any of the QuickBooks Integrator classs can connect to the QBConnector using the QBConnectionString property of any of the classs. For instance, an example using the Invoice class follows: Invoice.QBConnectionString = "URL='http://www.foo.com:2080'" User='Foo' Password='Bar'";

Using SSL along with a digital certificate greatly increases the security of the Remote Connector. SSL will encrypt all data transmitted across the network, ensuring that only the Connector can read incoming requests, and that only the requesting client can read the QuickBooks responses. This prevents unauthorized parties from accessing your QuickBooks data. You should use a full digital certificate on the server (Connector) side, and this will contain a public key and a private key. This version of your certificate should be kept private. You may export a version of the certificate containing the public key only, and distribute this to all clients that need to communicate with the Connector.

To use this functionality, set the SSLCert with a valid certificate and then change the SSLStartMode to sslImplicit. Now all clients must post to the QBConnector using HTTPS. eg: Invoice.QBConnectionString = "URL='https://www.foo.com:2080' User='Foo' Password='Bar'"; // https instead of http

The client (in these examples Invoice) has an SSLServerAuthentication event that will fire when the server presents its certificate. If the public key presented by the QBConnector is trusted by the system, the Accept parameter will be True. If it is not trusted by the system (Accept is False), you should inspect the certificate and if valid, override by setting Accept to True.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


AuthorizedUserCount	The number of records in the Authorized arrays.
AuthorizedAuthMode	This property defines how the user is authorized.
AuthorizedUserPassword	A password associated with the User who is allowed to connect to the class.
AuthorizedUserQBConnectionString	An aggregate consisting of various QuickBooks connection properties that are used to connect the authorized client to the QuickBooks application.
AuthorizedUser	Name of a user which is allowed to connect to the class.
ConnectedToQB	Opens or closes a persistent connection to QuickBooks.
EnableSSL	Indicates whether server starts in SSL-mode.
Listening	If set to True, the class accepts incoming connections on LocalPort.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the class listens.
SSLAuthenticateClients	If set to True, the server asks the client(s) for a certificate.
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
Timeout	An initial timeout value to be used by incoming connections.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


AddUser	Adds a new user to the AuthorizedUsers collection.
Config	Sets or retrieves a configuration setting.
DoEvents	Processes events from the internal message queue.
Reset	Clears all properties to their default values.
Shutdown	Shutdown the server.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Authorization	Fired when the client presents its credentials to the server.
Connected	This event is fired immediately after a connection completes (or fails).
ConnectionRequest	This event is fired when a request for connection comes from a remote host.
Disconnected	This event is fired when a connection is closed.
Error	This event fires information about errors during data delivery.
Header	HTTP headers sent by the client.
Request	Fired when a client sends a request to the class.
Response	Fired when the class sends a response to the client.
SSLClientAuthentication	This event is fired when the client presents its credentials to the server.
SSLConnectionRequest	This event fires when a Secure Sockets Layer (SSL) connection is requested.
SSLStatus	This event is fired to show the progress of the secure connection.
Status	Shows the status of the server as clients connect and transactions are made.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


AuthFlags	Auth Flags to use when connecting to QuickBooks.
ConnectedToQB	Used to connect or disconnect from QuickBooks.
DefaultConnectionString	Default connection string to use for users not in the AuthorizedUsers collection.
ReadOnly[i]	Whether a user is restricted to read-only access.
UseInteractiveLogon	Whether interactive or network logon is used when AuthMode is set to Windows.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

AuthorizedUserCount Property (InQB_QBConnector Class)

The number of records in the Authorized arrays.

Object Oriented Interface


public function getAuthorizedUserCount();


public function setAuthorizedUserCount($value);

Procedural Interface


inqb_qbconnector_get($res, 1 );


inqb_qbconnector_set($res, 1, $value );

Default Value

Remarks

This property controls the size of the following arrays:

AuthorizedAuthMode
AuthorizedUser
AuthorizedUserPassword
AuthorizedUserQBConnectionString

The array indices start at 0 and end at AuthorizedUserCount - 1.

This property is not available at design time.

Data Type

Integer

AuthorizedAuthMode Property (InQB_QBConnector Class)

This property defines how the user is authorized.

Object Oriented Interface


public function getAuthorizedAuthMode($authorizeduserindex);


public function setAuthorizedAuthMode($authorizeduserindex, $value);

Procedural Interface


inqb_qbconnector_get($res, 2 , $authorizeduserindex);


inqb_qbconnector_set($res, 2, $value , $authorizeduserindex);

Default Value

Remarks

This property defines how the user is authorized.

There are two ways that the user may be authorized, against the user list defined in the class, or as a Windows user. From the client side the process of connecting is exactly the same no matter which option you choose. Possible values are:


0 (amNormal - default)	The user is authenticated against the user list defined in the class.
1 (amWindows)	The user is authenticated as a Windows user.

When using the amNormal AuthMode (default) the user's password will be checked against the Password property.

When using the amWindows AuthMode the class will validate the user's credentials with Windows. When calling AddUser the Password parameter should be set to empty string.

The $authorizeduserindex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthorizedUserCount property.

This property is not available at design time.

Data Type

Integer

AuthorizedUserPassword Property (InQB_QBConnector Class)

A password associated with the User who is allowed to connect to the class.

Object Oriented Interface


public function getAuthorizedUserPassword($authorizeduserindex);


public function setAuthorizedUserPassword($authorizeduserindex, $value);

Procedural Interface


inqb_qbconnector_get($res, 3 , $authorizeduserindex);


inqb_qbconnector_set($res, 3, $value , $authorizeduserindex);

Default Value

Remarks

A password associated with the AuthorizedUser who is allowed to connect to the class. Connecting clients' authorization headers will be compared against this AuthorizedUser and AuthorizedPassword.

The $authorizeduserindex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthorizedUserCount property.

This property is not available at design time.

Data Type

String

AuthorizedUserQBConnectionString Property (InQB_QBConnector Class)

An aggregate consisting of various QuickBooks connection properties that are used to connect the authorized client to the QuickBooks application.

Object Oriented Interface


public function getAuthorizedUserQBConnectionString($authorizeduserindex);


public function setAuthorizedUserQBConnectionString($authorizeduserindex, $value);

Procedural Interface


inqb_qbconnector_get($res, 4 , $authorizeduserindex);


inqb_qbconnector_set($res, 4, $value , $authorizeduserindex);

Default Value

Remarks

An aggregate consisting of various QuickBooks connection properties that are used to connect the authorized client to the QuickBooks application.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:


ApplicationName	The name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access.
CompanyFile	The name of the company file to open. If QuickBooks is not currently open with a company file, QuickBooks will be automatically opened in the background with the file specified. Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the application UI, only that company file may be used.
QBConnectionMode	The mode of connection to QuickBooks. Specifies whether the integrated application logs in using single-user or multi-user mode. Allowable values include "DontCare", "SingleUserMode" and "MultiUserMode".

The $authorizeduserindex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthorizedUserCount property.

This property is not available at design time.

Data Type

String

AuthorizedUser Property (InQB_QBConnector Class)

Name of a user which is allowed to connect to the class.

Object Oriented Interface


public function getAuthorizedUser($authorizeduserindex);


public function setAuthorizedUser($authorizeduserindex, $value);

Procedural Interface


inqb_qbconnector_get($res, 5 , $authorizeduserindex);


inqb_qbconnector_set($res, 5, $value , $authorizeduserindex);

Default Value

Remarks

Name of a user which is allowed to connect to the class. Connecting clients' authorization headers will be compared against this AuthorizedUser and AuthorizedPassword.

The $authorizeduserindex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthorizedUserCount property.

This property is not available at design time.

Data Type

String

ConnectedToQB Property (InQB_QBConnector Class)

Opens or closes a persistent connection to QuickBooks.

Object Oriented Interface


public function getConnectedToQB();

Procedural Interface


inqb_qbconnector_get($res, 6 );

Default Value

false

Remarks

You may use this property to determine whether the class is currently connected to QuickBooks.

This property is read-only and not available at design time.

Data Type

Boolean

EnableSSL Property (InQB_QBConnector Class)

Indicates whether server starts in SSL-mode.

Object Oriented Interface


public function getEnableSSL();


public function setEnableSSL($value);

Procedural Interface


inqb_qbconnector_get($res, 7 );


inqb_qbconnector_set($res, 7, $value );

Default Value

false

Remarks

This property must be set before setting Listening to True. When EnableSSL is True, plaintext connections to the class will be rejected.

This property is not available at design time.

Data Type

Boolean

Listening Property (InQB_QBConnector Class)

If set to True, the class accepts incoming connections on LocalPort.

Object Oriented Interface


public function getListening();


public function setListening($value);

Procedural Interface


inqb_qbconnector_get($res, 8 );


inqb_qbconnector_set($res, 8, $value );

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the class is listening.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (InQB_QBConnector Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface


public function getLocalHost();


public function setLocalHost($value);

Procedural Interface


inqb_qbconnector_get($res, 9 );


inqb_qbconnector_set($res, 9, $value );

Default Value

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (InQB_QBConnector Class)

The TCP port in the local host where the class listens.

Object Oriented Interface


public function getLocalPort();


public function setLocalPort($value);

Procedural Interface


inqb_qbconnector_get($res, 10 );


inqb_qbconnector_set($res, 10, $value );

Default Value

2080

Remarks

The LocalPort property must be set before QBConnector starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of the LocalPort property after Listening is set to True.

The service port is not shared among servers (i.e. there can be only one QBConnector 'listening' on a particular port at one time).

The default value for LocalPort is 2080.

Data Type

Integer

SSLAuthenticateClients Property (InQB_QBConnector Class)

If set to True, the server asks the client(s) for a certificate.

Object Oriented Interface


public function getSSLAuthenticateClients();


public function setSSLAuthenticateClients($value);

Procedural Interface


inqb_qbconnector_get($res, 11 );


inqb_qbconnector_set($res, 11, $value );

Default Value

false

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEncoded Property (InQB_QBConnector Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


inqb_qbconnector_get($res, 13 );


inqb_qbconnector_set($res, 13, $value );

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (InQB_QBConnector Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface


public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface


inqb_qbconnector_get($res, 29 );


inqb_qbconnector_set($res, 29, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InQB_QBConnector Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface


public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface


inqb_qbconnector_get($res, 30 );


inqb_qbconnector_set($res, 30, $value );

Default Value

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (InQB_QBConnector Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


inqb_qbconnector_get($res, 31 );


inqb_qbconnector_set($res, 31, $value );

Default Value

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (InQB_QBConnector Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


inqb_qbconnector_get($res, 32 );


inqb_qbconnector_set($res, 32, $value );

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (InQB_QBConnector Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


inqb_qbconnector_get($res, 40 );


inqb_qbconnector_set($res, 40, $value );

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

Timeout Property (InQB_QBConnector Class)

An initial timeout value to be used by incoming connections.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


inqb_qbconnector_get($res, 41 );


inqb_qbconnector_set($res, 41, $value );

Default Value

Remarks

Timeout is used by the class to set the operational timeout value of all inbound connections once they are established.

The default value is 30 seconds.

Data Type

Integer

AddUser Method (InQB_QBConnector Class)

Adds a new user to the AuthorizedUsers collection.

Object Oriented Interface

public function doAddUser($user, $password, $qbconnectionstring, $authmode);

Procedural Interface

inqb_qbconnector_do_adduser($res, $user, $password, $qbconnectionstring, $authmode);

Remarks

Please refer to the AuthorizedUsers collection for more information.

User specifies the user which will be allowed to connect.

Password specifies the password of the user. This is not applicable when AuthMode is set to 1 (amWindows).

QBConnectionString sets the connection properties for the user. See AuthorizedUserQBConnectionString for details.

AuthMode defines how the user will be authenticated. There are two ways that the user may be authorized, against the user list defined in the class, or as a Windows user. From the client side the process of connecting is exactly the same no matter which option you choose. Possible values are:


0 (amNormal - default)	The user is authenticated against the user list defined in the class.
1 (amWindows)	The user is authenticated as a Windows user.

When using the amNormal AuthMode (default) the user's password will be checked against the Password property.

When using the amWindows AuthMode the class will validate the user's credentials with Windows. When calling AddUser the Password parameter should be set to empty string.

Config Method (InQB_QBConnector Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inqb_qbconnector_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (InQB_QBConnector Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

inqb_qbconnector_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Reset Method (InQB_QBConnector Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

inqb_qbconnector_do_reset($res);

Remarks

This method clears all properties to their default values.

Shutdown Method (InQB_QBConnector Class)

Shutdown the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

inqb_qbconnector_do_shutdown($res);

Remarks

When this method is called, the class will stop Listening, break all active connections, and disconnect from QuickBooks.

Authorization Event (InQB_QBConnector Class)

Fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireAuthorization($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 1, array($this, 'fireAuthorization'));

Parameter List

 'connectionid'
 'userindex'
 'user'
 'password'
 'accept'

Remarks

This is where the server can decide whether to continue or not, based on the supplied User and Password.

To accept or reject a connection set Accept to True of False.

The Accept parameter defaults to True if User is found in the AuthorizedUsers collection and Password matches, and False otherwise. The UserIndex parameter indicates the index at which the authorized user was found in the collection.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

Connected Event (InQB_QBConnector Class)

This event is fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 2, array($this, 'fireConnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (InQB_QBConnector Class)

This event is fired when a request for connection comes from a remote host.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 3, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

Disconnected Event (InQB_QBConnector Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Error Event (InQB_QBConnector Class)

This event fires information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ConnectionId indicates the connection for which the error is applicable.

Header Event (InQB_QBConnector Class)

HTTP headers sent by the client.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 6, array($this, 'fireHeader'));

Parameter List

 'connectionid'
 'header'
 'value'

Remarks

When a client connects, this event will fire for each HTTP header received.

Request Event (InQB_QBConnector Class)

Fired when a client sends a request to the class.

Object Oriented Interface

public function fireRequest($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 7, array($this, 'fireRequest'));

Parameter List

 'connectionid'
 'userindex'
 'request'

Remarks

This event will fire with the raw XML data received from the client, which is to be processed by QuickBooks.

The ConnectionId indicates which client connection this Request event is firing for. The UserIndex is the index of the user in the AuthorizedUser array property. Request is the QBXML Request sent from the client.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

Response Event (InQB_QBConnector Class)

Fired when the class sends a response to the client.

Object Oriented Interface

public function fireResponse($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 8, array($this, 'fireResponse'));

Parameter List

 'connectionid'
 'userindex'
 'response'

Remarks

This event will fire with the raw XML retrieved from QuickBooks and sent to the client.

The ConnectionId indicates which client connection this Request event is firing for. The UserIndex is the index of the user in the AuthorizedUser array property. Response is the QBXML Response from QuickBooks, which is being transmitted back to the client.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

SSLClientAuthentication Event (InQB_QBConnector Class)

This event is fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 9, array($this, 'fireSSLClientAuthentication'));

Parameter List

 'connectionid'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLConnectionRequest Event (InQB_QBConnector Class)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Object Oriented Interface

public function fireSSLConnectionRequest($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 10, array($this, 'fireSSLConnectionRequest'));

Parameter List

 'connectionid'
 'supportedciphersuites'
 'supportedsignaturealgs'
 'certstoretype'
 'certstore'
 'certpassword'
 'certsubject'

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

SSLStatus Event (InQB_QBConnector Class)

This event is fired to show the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 11, array($this, 'fireSSLStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

Status Event (InQB_QBConnector Class)

Shows the status of the server as clients connect and transactions are made.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 12, array($this, 'fireStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

The event is fired for informational and logging purposes only.

Config Settings (QBConnector Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

QBConnector Config Settings

AuthFlags: Auth Flags to use when connecting to QuickBooks.

This configuration setting controls what auth flags are sent to QuickBooks. The default value is 0 (no auth flags set).

ConnectedToQB: Used to connect or disconnect from QuickBooks.

This setting allows you to connect and disconnect to the QuickBooks request processor which resides on the server machine. Calling Config with ConnectedToQB=False will immediately disconnect from QuickBooks. ConnectedToQB=True, however, will use the DefaultConnectionString (if present) to open a persistent connection to QuickBooks. Note that if the class is already connected to QuickBooks, setting ConnectedToQB to True will cause the class to fails with an error. Connecting in this manner is only useful if there are no connection strings specified in any AuthorizedUsers, as in that case the class will disconnect from QuickBooks and reconnect with the credentials specified for that individual user. However, it is not necessary to use this configuration setting to connect to QuickBooks. If no connection strings are specified in the AuthorizedUsers and the class is not currently connected to QuickBooks, a new connection will be made using the DefaultConnectionString.

DefaultConnectionString: Default connection string to use for users not in the AuthorizedUsers collection.

If a user connects to the class who is not in the AuthorizedUsers collection, and you set the Accept parameter in the Authorization event to True anyways, the class will use this connection string to open a connection with QuickBooks. This is blank by default.

ReadOnly[i]: Whether a user is restricted to read-only access.

This setting specifies whether a user is limited to read-only access. The index should be the of the user in the AuthorizedUsers collection. For instance: QBConnector1.Config("ReadOnly[0]=True"); This indicates that the first user is limited to read-only access. The default value is False (full access).

UseInteractiveLogon: Whether interactive or network logon is used when AuthMode is set to Windows.

This setting only applies when the AuthorizedAuthMode is set to 1 (amWindows). When performing windows authentication a regular network logon is attempted by default. When this setting is set to true an interactive logon is performed instead. This setting may be required in certain circumstances, such as using a domain account and the domain controller is Samba.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (QBConnector Class)

Errors

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

QBConnector Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   IPDaemon is already listening.
106   Cannot change LocalPort when IPDaemon is Listening.
107   Cannot change LocalHost when IPDaemon is Listening.
108   Cannot change MaxConnections when IPDaemon is Listening.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
126   Invalid ConnectionId.
135   Operation would block.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).


	100 You cannot change the RemotePort at this time. A connection is in progress.
	101 You cannot change the RemoteHost at this time. A connection is in progress.
	102 The RemoteHost address is invalid (0.0.0.0).
	104 IPDaemon is already listening.
	106 Cannot change LocalPort when IPDaemon is Listening.
	107 Cannot change LocalHost when IPDaemon is Listening.
	108 Cannot change MaxConnections when IPDaemon is Listening.
	112 You cannot change MaxLineLength at this time. A connection is in progress.
	116 RemotePort cannot be zero. Please specify a valid service port number.
	126 Invalid ConnectionId.
	135 Operation would block.


	270 Cannot load specified security library.
	271 Cannot open certificate store.
	272 Cannot find specified certificate.
	273 Cannot acquire security credentials.
	274 Cannot find certificate chain.
	275 Cannot verify certificate chain.
	276 Error during handshake.
	280 Error verifying certificate.
	281 Could not find client certificate.
	282 Could not find server certificate.
	283 Error encrypting data.
	284 Error decrypting data.


	10004 [10004] Interrupted system call.
	10009 [10009] Bad file number.
	10013 [10013] Access denied.
	10014 [10014] Bad address.
	10022 [10022] Invalid argument.
	10024 [10024] Too many open files.
	10035 [10035] Operation would block.
	10036 [10036] Operation now in progress.
	10037 [10037] Operation already in progress.
	10038 [10038] Socket operation on non-socket.
	10039 [10039] Destination address required.
	10040 [10040] Message too long.
	10041 [10041] Protocol wrong type for socket.
	10042 [10042] Bad protocol option.
	10043 [10043] Protocol not supported.
	10044 [10044] Socket type not supported.
	10045 [10045] Operation not supported on socket.
	10046 [10046] Protocol family not supported.
	10047 [10047] Address family not supported by protocol family.
	10048 [10048] Address already in use.
	10049 [10049] Can't assign requested address.
	10050 [10050] Network is down.
	10051 [10051] Network is unreachable.
	10052 [10052] Net dropped connection or reset.
	10053 [10053] Software caused connection abort.
	10054 [10054] Connection reset by peer.
	10055 [10055] No buffer space available.
	10056 [10056] Socket is already connected.
	10057 [10057] Socket is not connected.
	10058 [10058] Can't send after socket shutdown.
	10059 [10059] Too many references, can't splice.
	10060 [10060] Connection timed out.
	10061 [10061] Connection refused.
	10062 [10062] Too many levels of symbolic links.
	10063 [10063] File name too long.
	10064 [10064] Host is down.
	10065 [10065] No route to host.
	10066 [10066] Directory not empty
	10067 [10067] Too many processes.
	10068 [10068] Too many users.
	10069 [10069] Disc Quota Exceeded.
	10070 [10070] Stale NFS file handle.
	10071 [10071] Too many levels of remote in path.
	10091 [10091] Network subsystem is unavailable.
	10092 [10092] WINSOCK DLL Version out of range.
	10093 [10093] Winsock not loaded yet.
	11001 [11001] Host not found.
	11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004 [11004] Valid name, no data record (check DNS setup).