CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode RemoteDevice_CollectSnapshotData_Async ( CPHOOKEDOBJECT const  hRemoteDevice,
SnapshotTypes const  snapshotType,
CPUINT32 const  dwOffset,
CPUINT32 const  dwContextData,
CPUINT16 const  wMaxBlockSize,
CPUINT32 const  dwClientContextData,
CPHASYNC *const  phAsync 
)

Collect Snapshot data.

Parameters
[in]hRemoteDeviceHandle to the remote device.
[in]snapshotTypeRequested snapshot information type. See SnapshotTypes
[in]dwOffsetCollect operation starts with offset 0.
[in]dwContextDataContext data. 0 for the 1st block, then value get from previous ARH_REMOTEDEVICE_COLLECTSNAPSHOTDATA
[in]wMaxBlockSizeSpecify a maximum block size. This is the maximum amount of data the collecting application can handle.
[in]dwClientContextDataData passed back to the ARH_REMOTEDEVICE_COLLECTSNAPSHOTDATA callback handler.
[out]phAsyncPointer to the handle of the async operation.
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
Warning
This function can only be called in CopperLan context. This means in the pseudo task CPDoProcess(), in notification handlers or in asynchronous return handlers and not in SystemDoProcess() for instance.