public method IO2GSession.getReportURL

Brief

Gets the URL for receiving the combo account statement report.

Declaration
C++
virtual int  getReportURL (char * urlBuffer, int bufferSize, IO2GAccountRow * account, DATE dateFrom, DATE dateTo, const char * format, const char * reportType, const char * langID, long ansiCP) = 0

Parameters
urlBuffer

The buffer to the URL. Use 0 to calculate the buffer size.
bufferSize

The size of urlBuffer.
account

The account row.
dateFrom

The start date of the report period.

The specified date will be used as the start date of the report period from the time of beginning of the trading day, independent of the specified time.

You can specify the date which corresponds to the zero OLE date in order to get the report since the account opening.
dateTo

The end date of the report period.

The specified date will be used as the end date of the report period to the time of ending of the trading day, independent of the specified time.

You can specify the date which corresponds to the zero OLE date in order to get the report to today.
format

The report format.

HTML

HTML format.

XML

XML format.

PDF

Adobe PDF format.

XLS

Microsoft Excel XML document format.
reportType

Use "REPORT_NAME_CUSTOMER_ACCOUNT_STATEMENT" for simple accounts and "REPORT_NAME_CUSTOMER_ACCOUNT_STATEMENT_PAMM" for PAMM accounts.
langID

The language and locale of the report.

enu

English

jpn

Japanese

fra

French

esp

Spanish

cht

Chinese Traditional

chs

Chinese Simplified

rus

Russian
ansiCP

The code page. Use 0 in order to use the default code page for the specified language and locale.

Returns

The number of characters written to the URL buffer if the function succeeds and urlBuffer is nonzero. The required size, in characters, for the buffer that will receive the URL string if the function succeeds and urlBuffer is zero.

A negative value indicates a failure. See O2GReportUrlError for possible values.

Details

The date and time in the report can be either in the UTC time zone or in the time zone of the server. It depends on the BASE_TIME_ZONE and SERVER_TIME_UTC system properties (see IO2GSystemPropertiesReader.findProperty for details). In case the value of the SERVER_TIME_UTC equals UTC, the date and time in the report will be in the UTC time zone. Otherwise, the date and time will be in the time zone specified in the BASE_TIME_ZONE system property.

Declared in IO2GSession

back