Ini_GetStringIntoBuffer

int Ini_GetStringIntoBuffer (IniText handle, const char sectionName[], const char tagName[], char buffer[], int bufferSize);

Purpose

Copies the string associated with tagName into buffer in the section identified by sectionName.

buffer must be able to contain at least as many bytes as indicated by bufferSize.

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.
tagName const char [] The tag name in the tag/value pair.
bufferSize integer The maximum number of bytes (including the ASCII NUL byte) to be written into buffer.
Output
Name Type Description
buffer char [] The buffer into which to copy the string associated with tagName. The buffer must be large enough to contain at least as many bytes as specified by bufferSize.

If an error occurs or the Tag Name cannot be found in the section, the first byte of buffer is set to ASCII NUL.

Return Value

Name Type Description
status integer Indicates whether a tag/string pair was found with the specified tagName in the section specified by sectionName.

A positive return value indicates that a tag/string pair was found. If the string portion of the tag/string pair was empty, such as in

tag 1 = ""

the string is considered to have been found, and it is the empty string (""). If the tag's value is empty, such as in

tag 1 =

no tag/value pair is found.

A zero indicates that no tag/string pair was found.

A negative value indicates an error. If the value is from –1 to –999, it is one of the error values defined in userint.h. If the value is from –5000 to –5999, it is one of the error values defined in toolbox.h.

For this function, the only error you are likely to encounter is:
–12 Out of memory!