SendRequest Event

Fires when QuickBooks Web Connector asks for a request.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireSendRequest(QBWCServerSendRequestEventParams *e);

typedef struct {
  const char *SessionTicket;
  const char *CompanyResponse;
  const char *HostResponse;
  const char *PrefsResponse;
  const char *CompanyFile;
  const char *QBXMLCountry;
  int QBXMLMajorVersion;
  int QBXMLMinorVersion;
  char *Request;
  int reserved;
} QBWCServerSendRequestEventParams;

Unicode (Windows)
virtual INT FireSendRequest(QBWCServerSendRequestEventParams *e);

typedef struct {
  LPCWSTR SessionTicket;
  LPCWSTR CompanyResponse;
  LPCWSTR HostResponse;
  LPCWSTR PrefsResponse;
  LPCWSTR CompanyFile;
  LPCWSTR QBXMLCountry;
  INT QBXMLMajorVersion;
  INT QBXMLMinorVersion;
  LPWSTR Request;
  INT reserved;
} QBWCServerSendRequestEventParams;

- (void)onSendRequest:(NSString*)sessionTicket :(NSString*)companyResponse :(NSString*)hostResponse :(NSString*)prefsResponse :(NSString*)companyFile :(NSString*)QBXMLCountry :(int)QBXMLMajorVersion :(int)QBXMLMinorVersion :(NSString**)request;

#define EID_QBWCSERVER_SENDREQUEST 11

virtual INT INQB_CALL FireSendRequest(LPSTR &lpszSessionTicket, LPSTR &lpszCompanyResponse, LPSTR &lpszHostResponse, LPSTR &lpszPrefsResponse, LPSTR &lpszCompanyFile, LPSTR &lpszQBXMLCountry, INT &iQBXMLMajorVersion, INT &iQBXMLMinorVersion, LPSTR &lpszRequest);

Remarks

This event fires when QuickBooks Web Connector is ready to accept a request. The purpose of the event is to provide a request to QuickBooks Web Connector. The parameters are as follows:

SessionTicket identifies the session. This value is read-only.

CompanyResponse holds a QBXML response to a Company Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company class. This value is read-only.

HostResponse holds a QBXML response to a Host Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company class. This value is read-only.

PrefsResponse holds a QBXML response to a Preferences Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company class. This value is read-only.

CompanyFile specifies the path to the company file that will be used in the data exchange. This value is read-only.

QBXMLCountry is the country version of QuickBooks. For instance "US", "CA", or "UK". This value is read-only.

QBXMLMajorVersion is the major version of the qbXML request processor (QBSDK version). For instance if the qbXML specification version is "6.0" this value will be "6". This value is read-only.

QBXMLMinorVersion is the minor version of the qbXML request processor (QBSDK version). For instance if the qbXML specification version is "6.0" this value will be "0". This value is read-only.

Request specifies the qbXML request that will be sent to QuickBooks Web Connector. This may be obtained from other classs in the toolkit by setting the QBRequestMode property to Offline. See the help for QBRequestMode for mode details.

Note: If the Request parameter is left empty QuickBooks Web Connector will then make a call and GetLastError will fire. This approach may be used if you wish to return an error, request interactive mode, or introduce a brief pause.