ClientVersion Event

Provides the QuickBooks Web Connector version information.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireClientVersion(QBWCServerClientVersionEventParams *e);

typedef struct {
  const char *ClientVersion;
  char *RequiredVersion;
  char *ErrorMessage;
  char *WarningMessage;
  int reserved;
} QBWCServerClientVersionEventParams;

Unicode (Windows)
virtual INT FireClientVersion(QBWCServerClientVersionEventParams *e);

typedef struct {
  LPCWSTR ClientVersion;
  LPWSTR RequiredVersion;
  LPWSTR ErrorMessage;
  LPWSTR WarningMessage;
  INT reserved;
} QBWCServerClientVersionEventParams;

- (void)onClientVersion:(NSString*)clientVersion :(NSString**)requiredVersion :(NSString**)errorMessage :(NSString**)warningMessage;

#define EID_QBWCSERVER_CLIENTVERSION 2

virtual INT INQB_CALL FireClientVersion(LPSTR &lpszClientVersion, LPSTR &lpszRequiredVersion, LPSTR &lpszErrorMessage, LPSTR &lpszWarningMessage);

Remarks

This event fires with the version information for QuickBooks Web Connector.

In most cases you do not need to do anything within this event. If no action is taken the session will proceed normally. You may optionally set parameters in this event to return an error, warning, or version requirement. The parameters are as follow:

ClientVersion holds the version of QuickBooks Web Connector that is connecting to your application. For instance "2.1.0.30".

RequiredVersion specifies the required version of QuickBooks Web Connector. You may set this to a value like "2.0". This is the minimum supported version of QuickBooks Web Connector which you will allow.

ErrorMessage may be set to return an error to QuickBooks Web Connector.

WarningMessage may be set to return a warning to QuickBooks Web Connector. The user will be prompted to continue or cancel the update.