Skip to content
Documentation

Ini_GetAllSectionVariables

Description

Section titled “Description”

Reads all entries in section. Only the entry names are returned, not their values. Use Ini_ReadEntry to read a value.

Syntax

Section titled “Syntax”

Ini_GetAllSectionVariables(sFile,sSection, sSeperateChar, bReturnAsArray, bMustExist) As Boolean

Parameters

Section titled “Parameters”

sFile (String)

Section titled “sFile (String)”

Filename

sSection (String)

Section titled “sSection (String)”

Section name

sSeperateChar (String)

Section titled “sSeperateChar (String)”

Character between each entry name in gsValue. Not used when bReturnAsArray is True.

bReturnAsArray (Boolean)

Section titled “bReturnAsArray (Boolean)”

Entry list must be returned in array

bMustExist (Boolean)

Section titled “bMustExist (Boolean)”

Section must exist. If True, the function returns False when the section doesn’t exist or contains no entries.

Return value

Section titled “Return value”

If bReturnAsArray is true the list of entries will be returned in gaValue otherwise the list will be returned in gsValue separated by sSeperateChar

Remarks

Section titled “Remarks”

The INI file must exist. If it doesn’t, the function returns False, whatever the value of bMustExist.

Example

Section titled “Example”
If bStatus Then bStatus = Ini_GetAllSectionVariables("C:\CapaInstaller.ini", "SectionName", "|", True, True)
If bStatus Then
  For index = LBound(gaValue) To UBound(gaValue)
    bStatus = Job_WriteLog("Custom", "Index #" & index & ": " & gaValue(index), bStatus, False)
  Next
End If

Scripting Guidelines

Section titled “Related functions”

Ini_DeleteSection Ini_GetAllSections Constants Package Property Variables