GetBlockId
Top  Previous  Next

Description

Returns the block ID of the last acquired frame.


Syntax


[VB]
Value=objActiveUSB.GetBlockId


[C/C++]
HRESULT GetBlockId(long* pValue);


Data Types
[VB]

Return value: Long


Parameters
[C/C++]

pValue [out,retval]  
Pointer to the timestamp value  


Return Values


S_OK  
Success  
E_FAIL  
Failure.  

Example


This VB example displays the block ID of each frame in a text box.

Private Sub ActiveUSB1_FrameAcquired()  
Label1.Caption = ActiveUSB1.GetBlockId  
End Sub  
 

Remarks


Block ID is an ordinal number (starting from 1) assigned by the camera to each acquired frame. Block IDs can be used to identify missing frames.

If this method is used in the FrameAcquired event handler, it must be called immediately after the event has been received. This will guarantee that the value of the block ID will not be taken from the next frame while the current frame is being processed.