ImageGear for C and C++ on Windows v19.4 - Updated
MED_DCM_DS_move_find_first
API Reference Guide > MD Component API Reference > MD Component Functions Reference > Data Set Functions > MED_DCM_DS_move_find_first

This function searches the Data Set associated with the HIGEAR image for the first Tag of the Group Number specified by GroupNum.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI MED_DCM_DS_move_find_first(
        const HIGEAR hIGear, 
        const AT_MODE level_op, 
        const WORD GroupNum, 
        LPAT_DCM_VR lpVR, 
        LPAT_DCM_VL lpVL, 
        LPDWORD lpLevel, 
        LPDWORD lpItem_count, 
        LPBOOL lpTagFound
);

Arguments:

Name Type Description
hIGear const HIGEAR HIGEAR handle of the image.
level_op const AT_MODE

A variable of type AT_MODE that tells the function how to move when it comes to an SQ. SQs are like indented outline items, allowing for hierarchies of Data Elements. Set this to one of the following constants:

  • MED_DCM_MOVE_LEVEL_FIXED: This setting tells the function to move only within the same level as the previous Current DE. An SQ and all its Data Elements are skipped over. If you are in a SQ, you can only move about the SQ.
  • MED_DCM_MOVE_LEVEL_FLOAT: This setting tells the function to move up or down as needed to get to the next DE. If the next DE is an SQ the Current DE moves down into it. At the end of the SQ, the Current DE will move back out to the lower levels (for example, from Level 2 to Level 1).
GroupNum const WORD Set this WORD variable to the Group Number for which to search.
lpVR LPAT_DCM_VR A far pointer which returns the new current VR (Value Representation). Set to NULL if you don't need this information. See enumIGMedVR for possible VR values.
lpVL LPAT_DCM_VL A far pointer which returns the length of the Data Field, in bytes. 
lpLevel LPDWORD A far pointer to a WORD which returns the level in the hierarchy of the new Current Data Element; set to NULL, if you do not need this information.
lpICount LPDWORD Returns the Item Count of the data; set to NULL if you don't need this information.
lpTagFound LPBOOL Returns TRUE is the Tag was found; FALSE otherwise.

Return Value:

Returns the number of ImageGear errors that occurred during the function call.

Supported Raster Image Formats:

This function does not process image pixels.

The image must have a DICOM DataSet attached to it. Use MED_DCM_DS_exists to check whether the image contains a DataSet.

Remarks:

When the first Tag with group GroupNum is found, the Data Element is made the Current Data Element. This function also returns the VR (Value Representation), the number of bytes in the Tag's data, and the Item Count.

Which levels of the Data Set will be considered depends on the setting of level_op.