ImageGear for C and C++ on Windows v20.0 - Updated
ART_global_block_delete
API Reference Guide > ART Component API Reference > ART Component Functions Reference > Global Named Block Management Functions > ART_global_block_delete

This function deletes an existing global named block, lpBlockName, from the set of global named blocks.

Declaration:

 
Copy Code
AT_ERRCOUNT ART_global_block_delete(
        HIGEAR hIGear, 
        const LPART_BLOCK_NAME lpBlockName
);

Arguments:

Name Type Description
hIGear HIGEAR HIGEAR handle to the image.
lpBlockName const LPART_BLOCK_NAME A far pointer to an 8-byte memory array contains the type of block to delete. 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:

None

Example:

 
Copy Code
HIGEAR hIGear; /* HIGEAR handle of image */
nErrcount = 
ART_global_block_delete(hIGear,"NOTES\000\000\000");

Remarks:

Reserved named blocks cannot be deleted. However, they may be modified by calling ART_global_block_create() function.

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

Is this page helpful?
Yes No
Thanks for your feedback.