Ini_NthItemName

int Ini_NthItemName (IniText handle, const char sectionName[], int itemIndex, char **itemTagNamePointer);

Purpose

Obtains a pointer to the tag name of the tag/value pair specified by the 1–based index in itemIndex, within the section identified by sectionName.

Do NOT modify the tag name or attempt to free the pointer.

Note  If the item was split across several lines, it has several tag names entries in the .ini file, as in the following.

<Tag Name> Line 0001
<Tag Name> Line 0002
<Tag Name> Line 0003

For the purposes of this function, the group of tag names counts as only one item with the name of <Tag Name>.

Parameters

Input
Name Type Description
handle IniText A handle returned from Ini_New. It represents the list of in-memory tag/value pairs.
sectionName const char [] The section name under which to find the tag/value pair.
itemIndex integer A 1–based index into the list tag/value pairs in the section identified by sectionName.
Output
Name Type Description
itemTagNamePointer char ** A pointer variable into which the address of the tag name is placed. Do NOT modify the tag name or attempt to free the pointer.

The pointer is valid until the next time the list of in–memory tag/value pairs is modified.

If there is no tag/value pair corresponding to the specified index in the section, the pointer variable is left untouched.

Return Value

Name Type Description
itemFound integer If there is a section corresponding to the specified index, 1 is returned.

Otherwise, 0 is returned.