This function deletes an existing named block.
Declaration:
|
Copy Code
|
AT_ERRCOUNT ART_mark_block_delete(
HIGEAR hIGear,
ART_MARK_INDEX hMarkIndex,
const LPART_BLOCK_NAME lpBlockName
);
|
Arguments:
Name |
Type |
Description |
hIGear |
HIGEAR |
HIGEAR handle to the image. |
hMarkIndex |
ART_MARK_INDEX |
Mark identifier. |
lpBlockName |
const LPART_BLOCK_NAME |
Tells ART what type of block to delete. Use an ART-defined constant beginning with ART_BLOCK. See ARTAPI.H for the full list. This parameter is also a user-defined block type. |
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:
None
Example:
|
Copy Code
|
HIGEAR hIGear; /* HIGEAR handle of image */
ART_MARK_INDEX hMarkIndex; /* index to the mark the */
/* block belongs to */
nErrcount = ART_mark_block_delete(hIGear, hMarkIndex,
ART_BLOCK_ANODAT);
|
Remarks:
It deletes the named block lpBlockName from the mark referenced by hMarkIndex.
- An error will be 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.