CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode LocalDevice_Reply_RequestCollectSnapshotData ( CPHOBJECT const  hLocalDevice,
CPUINT16 const  wRequestID,
SnapshotBlockPriorities const  priority,
CPUINT32 const  dwSnapshotContextData,
CPUINT16 const  wBlockSize,
CPBOOLEAN const  fLastBlock,
CPBYTE const *const  pBlockData 
)

Reply to a snapshot data collect request.

Call this to terminate a NH_LOCALDEVICE_SNAPSHOT_REQUESTCOLLECTSNAPSHOTDATA notification.

Parameters
[in]hLocalDeviceHandle to the local device.
[in]wRequestIDthe Request ID provided by the Request Notification Handler
[in]prioritythe restore priority for this type of data block. Must be the same for the whole data related to the requested type.
[in]dwSnapshotContextDataContext data related to the collected device, to be send back during next block collect. Can be used by the application as a session handling data sent back by during the request for next block.
[in]wBlockSizeBlock size. Must be <= wMaxBlockSize (from notification handler) Must remains identical for all replies. The application is not allowed to changed block size during snapshot collect operation.
[in]fLastBlockTRUE if it is the last block
[in]pBlockDatapointer to the data block.
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.