IG_REC_UD_section_first

This function has been deprecated and will be removed from the public API in a future release.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_UD_section_first_get( LPSTR pSection, AT_INT buflen );

Arguments:

Name	Type	Description
pSection	LPSTR	Pointer to a buffer for the name of the first section in the User dictionary.
buflen	AT_INT	Specifies the size of the buffer in bytes.

Return Value:

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

Supported Raster Image Formats:

This function does not process image pixels.

Example:

	Copy Code
AT_ERRCOUNT ErrCount = 0; AT_INT iSize = 1024; LPSTR lpszFirst = (LPSTR) malloc(iSize); ErrCount += IG_REC_UD_set("NEW_USER.DICT", "Section_A"); ErrCount += IG_REC_UD_edit_open(); ErrCount += IG_REC_UD_section_first_get(lpszFirst, iSize); ErrCount += IG_REC_UD_edit_close(); free(lpszFirst);

Copy Code

AT_ERRCOUNT ErrCount = 0;
AT_INT iSize = 1024;
LPSTR lpszFirst = (LPSTR) malloc(iSize);

ErrCount += IG_REC_UD_set("NEW_USER.DICT", "Section_A");
ErrCount += IG_REC_UD_edit_open();
ErrCount += IG_REC_UD_section_first_get(lpszFirst, iSize);

ErrCount += IG_REC_UD_edit_close();
free(lpszFirst);

Remarks:

Creates a listing of the sections in the User dictionary currently opened for editing by the IG_REC_UD_edit_open function.

This function should be used together with IG_REC_UD_section_next_get.

The lengths of each section name never exceeds AM_MAX_UD_SECTION_NAME_LEN characters (including the terminating zero).
The function appends IGW_LAST_ITEM_REACHED warning to the ImageGear error stack if there is no section in the User dictionary. Function IG_warning_check() returns non-zero value in this case, signaling that the list is complete.