ART_mark_block

This function gets the block name of the named block that follows the one that was last passed into lpBlockName.

Declaration:

	Copy Code
AT_ERRCOUNT ART_mark_block_next( HIGEAR hIGear, ART_MARK_INDEX hMarkIndex, LPART_BLOCK_NAME lpBlockName );

Arguments:

Name	Type	Description
hIGear	HIGEAR	HIGEAR handle to the image.
hMarkIndex	ART_MARK_INDEX	Mark identifier.
lpBlockName	LPART_BLOCK_NAME	A far pointer to an 8-byte array of memory that returns the type of block of the mark referenced by hMarkIndex. The block type is either an ART-defined constant beginning with ART_BLOCK or a user-defined block. See ARTAPI.H for the full list of ART-defined constants.

Return Value:

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

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Sample:

Annotation

Example:

See example under ART_mark_block_first() function.

Remarks:

ART_mark_block_first() is called to get the first block name. The block data for the named block is retrieved by calling ART_mark_block_query(). Both ART_mark_block_next() and ART_mark_block_first() set lpBlockName to zero when there are no more blocks (providing you an easy way to know when to end your loop). Block names are returned in no particular order.

To get the mark index needed for this function, you can call any of ART's functions that return a mark index, for example: ART_mark_first().

Many of ART's callback functions include the index number as a parameter. As part of your callback function, you can call ART_mark_block_first() and ART_mark_block_next() using the passed mark index.

An error is set if any of the following conditions are met:

hIGear does not reference a valid ImageGear handle.
There are no marks with a matching index block.
lpBlockName does not point to a valid address.