Skip to content
Documentation

Ini_GetAllSections

Description

Section titled “Description”

Reads all section-headers

Syntax

Section titled “Syntax”

Ini_GetAllSections(sFile, sSeperateChar, bReturnAsArray, bMustExist) As Boolean

Parameters

Section titled “Parameters”

sFile (String)

Section titled “sFile (String)”

Filename

sSeperateChar (String)

Section titled “sSeperateChar (String)”

Char between each section-header in gsValue. Not used when bReturnAsArray is True.

bReturnAsArray (Boolean)

Section titled “bReturnAsArray (Boolean)”

Section-list must be returned in array

bMustExist (Boolean)

Section titled “bMustExist (Boolean)”

At least one section must exist. If True, the function returns False when the file contains no sections.

Return value

Section titled “Return value”

If bReturnAsArray is true the list of section headers 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_GetAllSections("C:\CapaInstaller.ini", "|", True, True)
If bStatus Then
  For index = LBound(gaValue) To UBound(gaValue)
    bStatus = Job_WriteLog("Custom", "Index #" & index & ": " & gaValue(index), bStatus, True)
  Next
End If

Scripting Guidelines

Section titled “Related functions”

Ini_DeleteSection Ini_GetAllSectionVariables Constants Package Property Variables