Ini_GetStringCopy
- Updated2023-02-21
- 2 minute(s) read
int Ini_GetStringCopy (IniText handle, const char sectionName[], const char tagName[], char **copyOfString);
Purpose
Obtains a copy of the string associated with tagName in the section identified by sectionName.
You are responsible for freeing the string.
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. |
| Output | ||
| Name | Type | Description |
| copyOfString | char * | The pointer variable into which the address of the dynamically allocated copy of the string associated with tagName is placed.
You are responsible for freeing the string by calling the free function. If an error occurs or the Tag Name cannot be found in the section, the pointer is set to NULL. |
Return Value
| Name | Type | Description | ||
| status | int | 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:
|
Additional Information
Library: Reading/Writing .ini-Style Files
Include file: toolbox\inifile.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Example
Refer to compiler\versioning\versioning.cws for an example of using the Ini_GetStringCopy function.