ProSoft Technology MVI69-ADM - Manual (Page 177)

MVI-ADM ♦ 'C' Programmable Application Development Function Library - ADM API
'C' Programmable Application Development Module Developer's Guide
ProSoft Technology, Inc. Page 177 of 342
February 20, 2013
7.8 ADM API Flash Functions
ADM_FileGetString
Syntax
char* ADM_FileGetString(ADMHANDLE adm_handle, char *SubSec, char *Topic);
Parameters
adm_handle Handle returned by previous call to ADM_Open
SubSec Subsection denoted by [ ].
Topic The individual line item under the subsection.
Description
ADM_FileGetString allows an application to fetch a string topic under a
subsection of a configuration file located in flash. This function is valid for MVI94
only.
adm_handle must be a valid handle returned from ADM_Open.
SubSec must be a pointer to the subsection.
Topic must be a pointer to the topic.
Return Value:
Pointer to string where the data value starts. If the subsection is [Module] and the
topic is Module Name, then the pointer will point to the first non-space character
after the colon.
Example
Get the data from [Module]
Module Name: MVI56-ADM
The return value will point to the "M" at the start of MVI56-ADM.
ADMHANDLE adm_handle;
char *cptr;
cptr = ADM_FileGetString(adm_handle, "[Module]", "Module Name");
See Also
ADM_FileGetInt (page 178)
ADM_FileGetChar (page 179)