CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
typedef void(* NH_LOCALDEVICE_SNAPSHOT_REQUESTCOLLECTSNAPSHOTDATA)(CPHOBJECT const hLocalDevice, ObjectTypes const deviceType, CPUINT32 const dwDeviceUserData, CPUINT16 const wRequestID, SnapshotTypes const snapshotType, CPUINT32 const dwOffset, CPUINT32 const dwSnapshotContextData, CPUINT16 const wMaxBlockSize)

Called by the CHAI to request snapshot data related to the device.

This handler should call LocalDevice_Reply_InvalidRequest | LocalDevice_Reply_RequestCollectSnapshotData

Parameters
[in]hLocalDeviceHandle to the notified local device.
[in]deviceTypeType of the notified local device. See ObjectTypes
[in]dwDeviceUserDataThe user data associated to the device handle during its creation.
[in]wRequestIDThe request ID, it MUST be used with the response (LocalDevice_Reply_Request*).
[in]snapshotTypeRequested snapshot information type. See SnapshotTypes enumeration in CLC_Enums.h.
[in]dwOffsetData offset. First call is done with an offset 0.
[in]dwSnapshotContextDataContext data related to the collected device. 0 during the 1st call, then value transmitted with the previous reply
[in]wMaxBlockSizeMaximum size of the data block
Remarks
This notification is activated by using LocalDevice_RegisterSnapshotNotificationHandler. When this function is defined NH_LOCALDEVICE_SNAPSHOT_REQUESTRESTORESNAPSHOTDATA must also be defined.