ImageGear Professional for Unix
ART_global_block_first
ImageGear Professional v18.2 > API Reference Guide > ART Component API Reference > ART Component Functions Reference > Global Named Block Management Functions > ART_global_block_first

This function gets the name of the first global block.

Declaration:

 
Copy Code 
AT_ERRCOUNT ART_global_block_first(
        HIGEAR hIGear, 
        LPART_BLOCK_NAME lpBlockName
);

Arguments:

Name Type Description
hIGear HIGEAR HIGEAR handle to the image.
lpBlockName LPART_BLOCK_NAME A far pointer to an 8 byte array of memory that returns the type of block to query. 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 Professional.

Example

 
Copy Code 
HIGEAR  hIGear; /* HIGEAR handle of image */
ART_BLOCK_NAME lpBlockName; /* returned type of first */
/* global block  */
AT_ERRCOUNT nErrcount; /* tally of IG errors on */
/* stack  */
nErrcount = ART_global_block_first(hIGear,&lpBlockName);

Remarks:

The block data for the named block can be retrieved by calling ART_global_block_query() function.

Call ART_global_block_next() function to get the block name of the named block that follows the one that was passed into lpBlockName. This function sets lpBlockName to zeroes if there are no global blocks. Block names are returned in no particular order.

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

 

 

©2014. Accusoft Corporation. All Rights Reserved.

Send Feedback