| Customize Help
| Save Settings

MdigGetHookInfo


Function Map
Syntax
Description
Parameters
- EventId
- InfoType
- UserVarPtr
Parameter Associations
Table: For retrieving information about a general digitizer hook event
Table: For retrieving information about a GenICam SFNC-compliant event
Table: For retrieving information about a grab event
+ combination: For specifying the timer to inquire
+ combination: For retrieving information about the modified image buffer
Table: For retrieving information about an I/O event
Table: For retrieving information about a reference latch value
+ combination: For specifying the I/O command list to use
Table: For retrieving information about a rotary decoder event
+ combination: For specifying which rotary decoder to inquire
Table: For retrieving information from a data latch
+ combination: For specifying the data latch to inquire
+ combination: For identifying the instance of the stored information to retrieve
Table: For retrieving information from a GenICam feature change event
+ combination: For getting the string size
Table: For retrieving information from a grab frame burst event
Return value
Compilation information
Synopsis
Get information about a digitizer hook event.
Syntax
MIL_INT MdigGetHookInfo(
MIL_ID EventId, //in
MIL_INT64 InfoType, //in
void *UserVarPtr //out
)
Description

This function retrieves information about the digitizer event that caused the hook-handler function to be called. MdigGetHookInfo() should only be called within the scope of a digitizer hook-handler function (see MdigProcess() and MdigHookFunction()).

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
EventId

Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess() and MdigHookFunction()).

InfoType

Specifies the type of information about the event to return.

See the Parameter associations section for possible values that can be specified.

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT64

Specifies the address in which to write the requested information.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the InfoType parameter and possible values returned to the UserVarPtr parameter.

The following allows you to retrieve information about various digitizer hook event. Unless otherwise specified, you can retrieve these information types if you call this function from within a function hooked to any digitizer event using MdigHookFunction() or MdigProcess().

function map For retrieving information about a general digitizer hook event
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_DIGITIZER_ID

Retrieves the MIL identifier of the digitizer that was used by MdigProcess(). Note that this information is only available for digitizer events generated by MdigProcess().

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize MIL digitizer identifier

Specifies the MIL identifier of the digitizer.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_GC_CAMERA_TIME_STAMP

Retrieves the time at which the event occurred.

This value was generated by the camera, using a specialized counter. To inquire the time stamp generated by the operating system, use M_TIME_STAMP.

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ c
M10		 o v
Click to summarize Value

Specifies the camera's time stamp, in secs.

 ‡ c
M10		 o v
Click to summarize M_GC_EVENT_TYPE

Retrieves the GenICam event type, as sent by the camera. Refer to your GenICam SFNC specification, or your camera's documentation for a list of GenICam event types.

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the GigE Vision event type.

 ‡ c
M10		 o v
Click to summarize M_GC_PACKET_SIZE

Retrieves the size of the data packet, used by the GenICam SFNC-compliant camera when streaming data to the Host.

(summarize)
‡ c
M10
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10
Click to summarize Value

Specifies the size of the packet, in bytes.

 ‡ c
M10
Click to summarize M_GRAB_TRIGGER_MISSED

Retrieves the number of grab triggers missed.

This result is available only when MdigControl() with M_GRAB_TRIGGER_MISSED is set to M_ENABLE.

(summarize)
‡ t
U28
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ t
U28
Click to summarize Value

Specifies the number of missed triggers.

 ‡ t
U28
Click to summarize M_TIME_STAMP

Retrieves the operating system's time stamp at the point which the event generated a service request. The time stamp is generated by the operating system's performance counter. Time stamps can be used to see if a frame has been missed since the last time stamp.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
MIL system specific

This value is generated by the operating system. To use the time stamp generated by the camera, use M_GC_CAMERA_TIME_STAMP.

 ‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize Value

Specifies operating system's time stamp, in secs.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa

The following allows you to retrieve information about a GenICam SFNC-compliant event. The following information types are only available if MdigGetHookInfo() was called from a function hooked to a GenICam event using M_GC_EVENT. In addition, the GenICam event must be enabled using MdigControlFeature(), and the message channel must be supported by your camera.

function map For retrieving information about a GenICam SFNC-compliant event
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_COUNTER_INDEX

Retrieves the index of a counter on your camera.

You can retrieve this value if the hook-handler function was hooked using MdigHookFunction() with M_GC_EVENT + M_COUNTER_START + n or M_GC_EVENT + M_COUNTER_END + n, where n is the counter's index.

Counters are unique to GenICam SFNC-compliant cameras. To configure your GenICam SFNC-compliant counters, use MdigControlFeature().

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the index of the counter.

 ‡ c
M10		 o v
Click to summarize M_LINE_INDEX

Retrieves the index of the I/O signal that generated the GenICam SFNC-compatible camera's event. You can only retrieve this information if the hook-handler function was hooked using MdigHookFunction() with M_GC_EVENT + M_LINE_ANY_EDGE + n, M_GC_EVENT + M_LINE_FALLING_EDGE + n, or M_GC_EVENT + M_LINE_RISING_EDGE + n, where n is the I/O signal's number.

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the number of the I/O signal that generated the event.

 ‡ c
M10		 o v
Click to summarize M_TIMER_INDEX

Retrieves the index of the timer that generated the generic the GenICam SFNC-compatible camera's event. You can retrieve this value if the hook-handler function was hooked using MdigHookFunction() with M_GC_EVENT + M_TIMER_START + n or M_GC_EVENT + M_TIMER_END + M_TIMERn, where n is the timer index.

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the index of the timer that generated the event.

 ‡ c
M10		 o v

The following allows you to retrieve information about a grab event.

Unless otherwise specified, the following information types are only available if MdigGetHookInfo() was called from a function hooked to an event using MdigHookFunction() or MdigProcess() with M_GRAB_..._END. If inquired from any other hook function, these information types will not return an error, but the result will be irrelevant.

function map For retrieving information about a grab event
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_CORRUPTED_FRAME

Retrieves whether the currently grabbed frame is corrupt.

(summarize)
‡ c
M10		 i o u
U36		 v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 i o u
U36		 v
Click to summarize M_NO

Specifies that the frame is not corrupt.

 ‡ c
M10		 i o u
U36		 v
Click to summarize M_YES

Specifies that the frame is corrupt.

 ‡ c
M10		 i o u
U36		 v
Click to summarize M_GC_FRAME_BLOCK_ID

Retrieves the value of the counter (block ID) set by the camera for each grabbed frame. In this case, the value of the counter for the last frame grabbed is returned.

(summarize)
‡ c
M10		 o v
MIL system specific

Note that a GigE Vision 2.0 camera has a 64-bit frame counter, while a GigE Vision 1.0 camera has a 16-bit frame counter.

 ‡ c
U25
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the value of the counter.

 ‡ c
M10		 o v
Click to summarize M_GC_FRAME_BLOCK_ID64

Retrieves the value of the 64-bit counter (block ID) set by the camera for each grabbed frame. In this case, the value of the counter for the last frame grabbed is returned.

(summarize)
‡ c
M10		 o v
MIL system specific

Note that a GigE Vision 2.0 camera has a 64-bit frame counter, while a GigE Vision 1.0 camera has a 16-bit frame counter.

 ‡ c
U25
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
 ‡ c
M10		 o v
Click to summarize Value

Specifies the value of the counter.

 ‡ c
M10		 o v
Click to summarize M_GC_FRAME_ERROR_CODE

Retrieves the error code returned by the camera for the last frame grabbed.

(summarize)
‡ c
M10		 o
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o
Click to summarize Value

Specifies the GigE Vision error code.

 ‡ c
M10		 o
Click to summarize M_GC_FRAME_LINE_COUNT

Retrieves the number of rows in the last frame grabbed.

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the row count.

 ‡ c
M10		 o v
Click to summarize M_GC_FRAME_PIXEL_TYPE

Retrieves the data depth and raw color format of the last frame grabbed. Note that this value is a value, specified by GenICam's standard feature naming convention (SFNC). The predefined list of possible pixel formats are in the PFNC.h header file in the MIL installation folder, under the include\MilDyn subfolder.

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the data depth and raw color format of the last frame grabbed.

 ‡ c
M10		 o v
Click to summarize M_GC_FRAME_SIZE_X

Retrieves the width (size X) of the last frame grabbed.

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the width of the last frame grabbed.

 ‡ c
M10		 o v
Click to summarize M_GC_FRAME_SIZE_Y

Retrieves the height (size Y) of the last frame grabbed.

(summarize)
‡ c
M10		 o v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o v
Click to summarize Value

Specifies the height of the last frame grabbed, in pixels.

 ‡ c
M10		 o v
Click to summarize M_GC_FRAME_STATUS_CODE

Retrieves the status code from the last frame grabbed. The predefined list of frame status codes are in the GVCP_Status_Codes.h header file in the MIL installation folder, under the include\MilDyn subfolder.

(summarize)
‡ c
M10		 o
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 o
Click to summarize Value

Specifies the status code.

 ‡ c
M10		 o
Click to summarize M_GC_PACKETS_MISSED

Retrieves the number of missing packets in the corrupted frame. If 0 is returned, the frame is not corrupted.

(summarize)
‡ c
M10
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10
Click to summarize Value

Specifies the number of missing packets.

 ‡ c
M10
Click to summarize M_GC_PACKETS_RECEIVED

Retrieves the number of packets in the frame.

(summarize)
‡ c
M10
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10
Click to summarize Value

Specifies the number of packets in the frame.

 ‡ c
M10
Click to summarize M_GC_PACKETS_RECOVERED

Retrieves the number of packets successfully recovered in the frame.

(summarize)
‡ c
M10
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10
Click to summarize Value

Specifies the number of recovered packets.

 ‡ c
M10
Click to summarize M_GC_PACKETS_RESENDS_NUM

Retrieves the number of resend commands sent to the camera for a frame. Note that one resend command can contain multiple consecutive packets.

(summarize)
‡ c
M10
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10
Click to summarize Value

Specifies the number of resend commands sent.

 ‡ c
M10
Click to summarize M_GRAB_LINE

Retrieves the number of the line (row) that, upon it being received by the digitizer, generated the event. You can only retrieve this information if the hook-handler function was hooked using MdigHookFunction() with M_GRAB_LINE + n, where n is the row number. Note that upon this event, the row has not necessarily been written to the grab buffer.

(summarize)
‡ g h i k
M10		 l m t
U28		 y
U75
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g h i k
M10		 l m t
U28		 y
U75
Click to summarize Value

Specifies the row number.

 ‡ g h i k
M10		 l m t
U28		 y
U75
Click to summarize M_GRAB_LINE_COUNT

Retrieves the number of lines (rows) grabbed. Note that the data contained in the line is available for processing. This is useful when grabbing from a line-scan camera with frames of variable length.

(summarize)
‡ c
M10		 k
M10		 l m o p r
U27		 y
U75		 aa
MIL system specific

You can only retrieve this value if the hook-handler function was hooked using MdigProcess() or MdigHookFunction() with M_GRAB_END or M_GRAB_FRAME_END.

 ‡ c
M10		 o

You can only retrieve this value if the row count was enabled using MdigControl() with M_GRAB_LINE_COUNTER and the hook-handler function was hooked using MdigProcess() or MdigHookFunction() with M_GRAB_END or M_GRAB_FRAME_END.

 ‡ k
M10		 l m p r
U27		 y
U75		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 k
M10		 l m o p r
U27		 y
U75		 aa
Click to summarize Value

Specifies the row number.

 ‡ c
M10		 k
M10		 l m o p r
U27		 y
U75		 aa
Click to summarize M_GRAB_LINE_END

Retrieves the number of the line (row) that, upon it being available in the grab buffer, generated the event. You can only retrieve this information if the hook-handler function was hooked using MdigHookFunction() with M_GRAB_LINE_END + n, where n is the row number. Note that upon this event, the row is available in the grab buffer.

(summarize)
‡ l m
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ l m
Click to summarize Value

Specifies the row number.

 ‡ l m
Click to summarize M_MODIFIED_BUFFER +

Retrieves information about a modified-buffer type of event.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize Value

Specifies information about a modified-buffer event.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_TIMER_TRIGGER_MISSED +

Retrieves the number of triggers missed by the specified timer. You can only retrieve this value if MdigGetHookInfo() was called from a function hooked to an end of grab event using MdigHookFunction() with M_GRAB_END or if the hook-handler function was hooked using MdigProcess().


You must specify a combination value from the following table:
(summarize)
‡ j k
M10		 l m p r
U27		 y
U75		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j k
M10		 l m p r
U27		 y
U75		 aa
Click to summarize Value

Specifies the number of missed triggers.

 ‡ j k
M10		 l m p r
U27		 y
U75		 aa
Combination value for M_TIMER_TRIGGER_MISSED.

You must add the following value to the above-mentioned value to set the timer to inquire.

function map For specifying the timer to inquire
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_TIMERn

Specifies the timer, where n can be from 1 to 4.

 ‡ j k
M10		 l m p r
U27		 y
U75		 aa
Combination values for M_MODIFIED_BUFFER.

You can add one of the following values to the above-mentioned value to specify the type of information to return about the modified image buffer.

function map For retrieving information about the modified image buffer
Click to summarizeInfoType Description
UserVarPtr
- Possible values returned
Click to summarize M_BUFFER_ID

Retrieves the MIL identifier of the modified image buffer.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
Click to summarize MIL buffer identifier

Specifies the MIL identifier of the modified image buffer associated with the event.
Click to summarize M_BUFFER_INDEX

Retrieves the index of the modified image buffer in the image buffer array passed to MdigProcess(), if the hook-handler function was hooked using MdigProcess(). This index always starts at 0.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value

Specifies the index of the modified image buffer.
Click to summarize M_REGION_OFFSET_X

Retrieves the X-offset of the modified region (of the image buffer).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value

Specifies the X-offset of the modified region.
Click to summarize M_REGION_OFFSET_Y

Retrieves the Y-offset of the modified region (of the image buffer).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value

Specifies the Y-offset of the modified region.
Click to summarize M_REGION_SIZE_X

Retrieves the width of the modified region (of the image buffer).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value

Specifies the width of the modified region.
Click to summarize M_REGION_SIZE_Y

Retrieves the height of the modified region (of the image buffer).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value

Specifies the height of the modified region.

The following allows you to retrieve information about an I/O event. These information types are only available if MdigGetHookInfo() was called from a function hooked to event using MdigHookFunction() with M_IO_CHANGE.

function map For retrieving information about an I/O event
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_IO_INTERRUPT_SOURCE

Retrieves the auxiliary input signal that generated the interrupt.

(summarize)
‡ c
M10		 j k
M10		 l m o p r
U27		 v y
U75		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 j k
M10		 l m o p r
U27		 v y
U75		 aa
Click to summarize M_AUX_IOn

Specifies the auxiliary input signal that generated the interrupt, where n is the signal number.

 ‡ c
M10		 j k
M10		 l m o p r
U27		 v y
U75		 aa
Click to summarize M_IO_STATUS

Retrieves the state of the input signal that generated the interrupt. The returned value reflects the state of the input signal at the time of the interrupt.

(summarize)
‡ c
M10		 j k
M10		 l m o p r
U27		 v y
U75		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c
M10		 j k
M10		 l m o p r
U27		 v y
U75		 aa
Click to summarize M_OFF

Specifies that the auxiliary input signal that generated the interrupt is off.

 ‡ c
M10		 j k
M10		 l m o p r
U27		 v y
U75		 aa
Click to summarize M_ON

Specifies that the auxiliary input signal that generated the interrupt is on.

 ‡ c
M10		 j k
M10		 l m o p r
U27		 v y
U75		 aa

The following allows you to retrieve information about a reference latch event. The following information types are only available if using a latch that has previously saved the time or counter value upon a hardware event and using MdigHookFunction() with any hook event.

function map For retrieving information about a reference latch value
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_REFERENCE_LATCH_VALUE +

Retrieves the last timestamp or counter value stored by the specified latch.


You must specify a combination value from the following table:
(summarize)
‡ t
U28
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
 ‡ t
U28
Click to summarize Value

Specifies the last timestamp or counter value stored by the specified latch.

 ‡ t
U28
Combination value for M_REFERENCE_LATCH_VALUE.

You must add the following value to the above-mentioned value to specify which of the I/O command lists to use.

function map For specifying the I/O command list to use
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_IO_COMMAND_LIST1

Specifies to inquire about I/O command list1.

 ‡ t
U28

The following allows you to retrieve information about a rotary decoder event. This information type is only available if MdigGetHookInfo() was called from a function hooked to event using MdigHookFunction() with M_ROTARY_ENCODER. In addition, you must have enabled the rotary decoder to store this information (before the grab), using MdigControl() with M_ROTARY_ENCODER_FRAME_END_READ. Note that the current value of the rotary decoder's counter can be inquired using MdigInquire() with M_ROTARY_ENCODER_POSITION.

function map For retrieving information about a rotary decoder event
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_ROTARY_ENCODER_FRAME_END_POSITION +

Retrieves the value of the rotary decoder's counter at the end of the last frame grabbed before the counter reached its trigger position.

(summarize)
‡ j k
M10		 m p r
U27		 y
U75		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j k
M10		 m p r
U27		 y
U75		 aa
Click to summarize Value

Specifies the value of the rotary decoder's counter when the last frame was grabbed.

 ‡ j k
M10		 m p r
U27		 y
U75		 aa
Combination value for M_ROTARY_ENCODER_FRAME_END_POSITION.

You can add the following value to the above-mentioned value to specify which rotary decoder to inquire.

function map For specifying which rotary decoder to inquire
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_ROTARY_ENCODERn

Specifies to inquire rotary decoder n, where n is a number between 1 and 4.

Note that if you do not use this combination constant to specify a rotary decoder, the rotary decoder corresponding to 1+ the device number of the specified digitizer (using MdigHookFunction() with DigId) will be used. For example, when the device number of the specified digitizer is M_DEV2, rotary decoder M_ROTARY_ENCODER3 is used.

(summarize)
‡ k
M10		 p r
U27		 y
U75		 aa

The following allows you to retrieve information from a data latch. These information types are only available if MdigGetHookInfo() was called from a function hooked to an end of grabbed frame event using MdigHookFunction() with M_GRAB_FRAME_END or from the hook-handler function (callback function) of MdigProcess(). In addition, you must have enabled the data latch to store this information, using MdigControl() with M_DATA_LATCH_STATE.

Note that you can only use data latches in association with the MIL digitizer allocated using MdigAlloc() with M_DEV0.

function map For retrieving information from a data latch
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_DATA_LATCH_VALUE +

Retrieves the stored data of the specified data latch. If there are multiple instances of this data (for example, your data latch is triggered at the end of each grabbed line), use + M_VALUE_INDEX().

(summarize)
‡ k
M10		 p r
U27		 y
U75		 aa
MIL system specific

You must specify a combination value from the following table:
‡ p r
U27		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
 ‡ k
M10		 p r
U27		 y
U75		 aa
Click to summarize M_NULL

Specifies that the stored data could not be read.

 ‡ k
M10		 p r
U27		 y
U75		 aa
Click to summarize Value

Specifies the stored data.

 ‡ k
M10		 p r
U27		 y
U75		 aa
Click to summarize M_DATA_LATCH_VALUE_ALL +

Retrieves all the stored data of the specified data latch.

(summarize)
‡ k
M10		 p r
U27		 y
U75		 aa
MIL system specific

You must specify a combination value from the following table:
‡ p r
U27		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
 ‡ k
M10		 p r
U27		 y
U75		 aa
Click to summarize Value

Specifies all the stored data.

 ‡ k
M10		 p r
U27		 y
U75		 aa
Click to summarize M_DATA_LATCH_VALUE_COUNT +

Counts the number of items stored inside a data latch. Note that a data latch is reset at every frame event.

(summarize)
‡ k
M10		 p r
U27		 y
U75		 aa
MIL system specific

You must specify a combination value from the following table:
‡ p r
U27		 aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
 ‡ k
M10		 p r
U27		 y
U75		 aa
Click to summarize Value

Specifies the number of instances. Note that a data latch is reset at every frame event.

(summarize)
‡ k
M10		 p r
U27		 y
U75		 aa
Combination value for the values listed in For retrieving information from a data latch.

You must add the following value to the above-mentioned values to specify which data latch to inquire about.

function map For specifying the data latch to inquire
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_LATCHn

Specifies the data latch from which to retrieve information, where n is a value from 0 to 15.

 ‡ p r
U27		 aa
Combination value for M_DATA_LATCH_VALUE.

You can add the following value to the above-mentioned value to specify the instance of the stored information to retrieve.

function map For identifying the instance of the stored information to retrieve
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize

Specifies the instance of stored information to retrieve.

(summarize)
‡ k
M10		 p r
U27		 aa
Parameters

Sets the instance of stored information. For example, to read the information latched when the last line finishes being grabbed for a frame, with 1024 lines, the instance would be 1023.

 ‡ k
M10		 p r
U27		 aa

The following allows you to retrieve information from a GenICam feature change event. These information types are only available if MdigGetHookInfo() was called from a function hooked to GenICam feature change event using MdigHookFunction() with M_FEATURE_CHANGE.

function map For retrieving information from a GenICam feature change event
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_GC_FEATURE_CHANGE_NAME +

Retrieves the name of the GenICam feature that changed.

(summarize)
‡ c
U25		 v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
 ‡ c
U25		 v
Click to summarize Value

Specifies the feature name.

 ‡ c
U25		 v
Combination value for M_GC_FEATURE_CHANGE_NAME.

You can add the following value to the above-mentioned value to get the string's length.

function map For getting the string size
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_STRING_SIZE

Retrieves the length of the string, including the terminating null character ("\0").

(summarize)
‡ v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ v

The following allows you to retrieve information about events that occur when grabbing into a multi-frame buffer (frame burst events). Unless otherwise specified, you can retrieve these information types if you call this function from within a function hooked to a frame end event using MdigHookFunction() with M_GRAB_FRAME_END or MdigProcess().

function map For retrieving information from a grab frame burst event
Click to summarizeInfoType Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_GRAB_FRAME_BURST_COUNT

Retrieves the number of frames grabbed into the multi-frame buffer.

(summarize)
‡ k
U29		 y
U75
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ k
U29		 y
U75
Click to summarize Value

Specifies the number of frames grabbed.

 ‡ k
U29		 y
U75
Click to summarize M_GRAB_FRAME_BURST_END_SOURCE

Retrieves the type of event(s) that ended the grab of sequential frames into the multi-frame buffer (end of the frame burst). Simultaneous events might have caused the end of grab to happen, so a combination of the values below can be returned. Bitwise operators must be used to verify the presence of a specific returned value.

(summarize)
‡ k
U29		 y
U75
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT MORE
 ‡ k
U29		 y
U75
Click to summarize M_BURST_COUNT

Specifies that the entire group of sequential frames have been grabbed into the multi-frame buffer. To specify the number of frames in a frame burst, use MdigControl() with M_GRAB_FRAME_BURST_SIZE.

(summarize)
‡ k
U29		 y
U75
Click to summarize M_BURST_MAX_TIME

Specifies that the maximum frame burst time has elapsed. To specify the maximum time for a frame burst to complete, use MdigControl() with M_GRAB_FRAME_BURST_MAX_TIME.

(summarize)
‡ k
U29		 y
U75
Click to summarize M_BURST_TRIGGER

Specifies that an end-of-frame-burst trigger occurred. To enable using an end-of-frame-burst trigger to end the grab, use MdigControl() with M_GRAB_FRAME_BURST_END_TRIGGER_STATE.

(summarize)
‡ k
U29		 y
U75
Return value
The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
HOST HOST DIGITIZER ID GC CAMERA TIME STAMP GC EVENT TYPE GC PACKET SIZE GRAB TRIGGER MISSED TIME STAMP COUNTER INDEX LINE INDEX TIMER INDEX CORRUPTED FRAME NO YES GC FRAME BLOCK ID GC FRAME BLOCK ID64 GC FRAME ERROR CODE GC FRAME LINE COUNT GC FRAME PIXEL TYPE GC FRAME SIZE X GC FRAME SIZE Y GC FRAME STATUS CODE GC PACKETS MISSED GC PACKETS RECEIVED GC PACKETS RECOVERED GC PACKETS RESENDS NUM GRAB LINE GRAB LINE COUNT GRAB LINE END MODIFIED BUFFER TIMER TRIGGER MISSED TIMERn BUFFER ID GRAB PROC BUFFER INDEX REGION OFFSET X REGION OFFSET Y REGION SIZE X REGION SIZE Y IO INTERRUPT SOURCE AUX IOn IO STATUS OFF ON REFERENCE LATCH VALUE IO COMMAND LIST1 ROTARY ENCODER FRAME END POSITION ROTARY ENCODERn DATA LATCH VALUE NULL DATA LATCH VALUE ALL DATA LATCH VALUE COUNT LATCHn GC FEATURE CHANGE NAME STRING SIZE GRAB FRAME BURST COUNT GRAB FRAME BURST END SOURCE BURST COUNT BURST MAX TIME BURST TRIGGER M_TIMERn M_AUX_IOn M_ROTARY_ENCODERn M_LATCHn