C++ SDK

◆ GetHistoryList()

static int CApplicationAPI::GetHistoryList ( LpError  lpError,
SHistoryRecord *&  lstHistoryArr,
int &  nSize,
BOOL  bSearchAddress,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function returns the list of items in History.

Parameters
lpErrorAdditional error information returned from Drive.
lstHistoryArrArray of SHistoryRecord which contains retrieved items.
nSizeSize of the lstHistoryArr array.
bSearchAddressSpecify whether GetHistoryList searches for address or not. If bSearchAddress=true GetHistoryList fills address member of each HistoryArr item (see SHistoryRecord type) with corresponding address.
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

Possible error codes returned from Drive are:

  • 0 - Function not succeeded.
  • 1 - Function succeeded.
  • 2 - Drive not succeeded.
  • 3 - Function reached timeout.