Synopsis
Inquire about a digitizer.
Format
long MdigInquire(DigId, ParamToInquire, UserVarPtr)
MIL_ID DigId; | Digitizer identifier |
long InquireType; | Type of information to inquire |
void *UserVarPtr; | Storage location for inquired information |
Description
This function inquires about the specified digitizer parameter setting.
The DigId parameter specifies the identifier of the digitizer.
The InquireType parameter specifies the digitizer parameter about which to inquire. This parameter can be set to one of the following values:
InquireType | Description |
M_OWNER_SYSTEM | The MIL identifier (MIL_ID) of the system on which the digitizer has been allocated (MdigAlloc). |
M_NATIVE_ID | The native identifier of the digitizer (if any). |
M_NUMBER | Digitizer rank in the system (MdigAlloc). |
M_FORMAT | Digitizer data format (MdigAlloc). |
M_FORMAT_SIZE | Number of characters in the digitizer data format string. |
M_INIT_FLAG | Digitizer initialization flag (MdigAlloc). |
M_CHANNEL | Current channel of the digitizer (MdigChannel). |
M_CHANNEL+M_SYNC | Current synchronization channel of the digitizer (MdigChannel). |
M_CHANNEL+M_SIGNAL | Current signal channel of the digitizer (MdigChannel). |
M_CHANNEL_NUM | Number of available channels of the device (MdigChannel). |
M_LUT_ID | MIL identifier (MIL_ID) of the LUT associated with the digitizer (MdigLut). |
M_BLACK_REF | Digitizer black reference level (MdigReference). |
M_WHITE_REF | Digitizer white reference level (MdigReference). |
M_HUE_REF | Digitizer hue reference level (MdigReference). |
M_SATURATION_REF | Digitizer saturation reference level (MdigReference). |
M_BRIGHTNESS_REF | Digitizer brightness reference level (MdigReference). |
M_CONTRAST_REF | Digitizer contrast reference level (MdigReference). |
M_GRAB_SCALE_X | Digitizer horizontal scaling factor (MdigControl). |
M_GRAB_SCALE_Y | Digitizer vertical scaling factor (MdigControl). |
M_GRAB_MODE | Grab synchronization (M_SYNCHRONOUS or M_ASYNCHRONOUS) (MdigControl). |
M_GRAB_FRAME_NUM | Number of frames grabbed when MdigGrab is called (MdigControl). |
M_GRAB_FIELD_NUM | Number of fields grabbed when MdigGrab is called (MdigControl). |
M_GRAB_START_MODE | Type of field on which to grab. |
M_GRAB_HALT_ON_NEXT_FIELD | Whether to stop grabbing as soon as possible, whether the last frame is valid or not. (MdigControl). |
M_GRAB_TRIGGER_SOURCE | Grab trigger source (MdigControl). |
M_GRAB_TRIGGER_MODE | Hardware trigger activation mode (MdigControl). |
M_GRAB_TRIGGER | Grab trigger state (M_ENABLE, M_DISABLE, M_START_GRAB or M_DEFAULT (same as .dcf, if any, or M_DISABLE) (MdigControl). |
M_GRAB_START_HANDLER_PTR | The pointer of the grab hook to start of grab. |
M_GRAB_START_HANDLER_USER_PTR | The user pointer of the grab hook to start of grab. |
M_GRAB_END_HANDLER_PTR | The pointer of the grab hook to end of grab. |
M_GRAB_END_HANDLER_USER_PTR | The user pointer of the grab hook to end of grab. |
M_GRAB_FRAME_START_HANDLER_PTR | The pointer of the grab hook to start of frame grab. |
M_GRAB_FRAME_START_HANDLER_USER_PTR | The user pointer of the grab hook to start of frame grab. |
M_GRAB_FRAME_END_HANDLER_PTR | The pointer of the grab hook to end of frame grab. |
M_GRAB_FRAME_END_HANDLER_USER_PTR | The user pointer of the grab hook to end of frame grab. |
M_FIELD_START_HANDLER_PTR | The pointer of the grab hook to start of field. |
M_FIELD_START_HANDLER_USER_PTR | The user pointer of the grab hook to start of field. |
M_FIELD_START_ODD_HANDLER_PTR | The pointer of the grab hook to start of odd field. |
M_FIELD_START_ODD_HANDLER_USER_PTR | The user pointer of the grab hook to start of odd field. |
M_FIELD_START_EVEN_HANDLER_PTR | The pointer of the grab hook to start of even field. |
M_FIELD_START_EVEN_HANDLER_USER_PTR | The user pointer of the grab hook to start of even field. |
M_GRAB_FIELD_END_HANDLER_PTR | The pointer of the grab hook to end of field grab. |
M_GRAB_FIELD_END_HANDLER_USER_PTR | The user pointer of the grab hook to end of field grab. |
M_GRAB_FIELD_END_ODD_HANDLER_PTR | The pointer of the grab hook to end of odd field grab. |
M_GRAB_FIELD_END_ODD_HANDLER_USER_PTR | The user pointer of the grab hook to end of odd field grab. |
M_GRAB_FIELD_END_EVEN_HANDLER_PTR | The pointer of the grab hook to end of even field grab. |
M_GRAB_FIELD_END_EVEN_HANDLER_USER_PTR | The user pointer of the grab hook to end of even field grab. |
M_FRAME_START_HANDLER_PTR | The pointer of the grab hook to start of frame. |
M_FRAME_START_HANDLER_USER_PTR | The user pointer of the grab hook to start of frame. |
M_SIZE_X | Digitizer input width. |
M_SIZE_Y | Digitizer input height. |
M_SIZE_BAND | Number of input color bands of the digitizer. |
M_SIZE_BAND_LUT | Number of input color bands of the input LUT (if any) associated with the digitizer. |
M_SIZE_BIT | Number of bits of the digitizer. |
M_SIGN | Digitizer data range (M_SIGNED or M_UNSIGNED). |
M_TYPE | Digitizer data type (number of bits + M_SIGNED or M_UNSIGNED). |
M_SOURCE_SIZE_X | Width of the input-signal capture window. |
M_SOURCE_SIZE_Y | Height of the input-signal capture window. |
M_SOURCE_OFFSET_X | X offset of the input-signal capture window. |
M_SOURCE_OFFSET_Y | Y offset of the input signal capture window. |
M_COLOR_MODE | Monochrome or color input. |
M_SCAN_MODE | Scan mode (M_INTERLACE, M_PROGRESSIVE, or M_LINESCAN). |
M_INPUT_MODE | Analog or digital input. |
You can inquire about the reference level on a specific input channel by adding one of the following predefined values to M_BLACK_REF and M_WHITE_REF.
M_CH0_REF | Inquire about reference level on channel 0 (default). |
M_CH1_REF | Inquire about reference level on channel 1. |
M_CH2_REF | Inquire about reference level on channel 2. |
M_CH3_REF | Inquire about reference level on channel 3. |
For example M_BLACK_REF+M_CH1_REF.
The UserVarPtr parameter specifies the address of the variable in which the requested information is to be written. Since the MdigInquire function also returns the requested information, you can set this parameter to M_NULL.
The UserVarPtr parameter should be a pointer to a long, except when InquireType is set to one of the following:
- M_OWNER_SYSTEM and M_LUT_ID, in which case it should be a pointer to a MIL_ID.
- M_FORMAT, in which case it should be a pointer to a character array.
- M_GRAB_SCALE_X and M_GRAB_SCALE_Y, in which case it should be a pointer to a double.
Returned value
The returned value is the requested digitizer parameter setting, cast to long.
See also
《MdigInquire()函数》上有2条评论
评论已关闭。