COM API

Segment property

Example | Applies To

This property returns the ConfigurationSegment object based on the name of the segment/section of an INVOICES INI file. It is normally used in combination with the KeyValue property to set or return values of INI file settings.

If you directly apply the KeyValue property to the Configuration(eiLocalMachineScope) object, INVOICES assumes the value of Segment (in Eilocal.ini) to be [ModuleName::PluginName], where ModuleName and PluginName are the actual names of the INVOICES module and plug-in, respectively.

Syntax

object.Segment(sSegmentKey As String) [= value]

Part

Description

object

An expression that evaluates to an object in this list.

sSegmentKey

The name of a section in an INI file, such as Events in Eilocal.ini.

value

An object of ConfigurationSegment type.

Example

sServerName = m_EHIApplication.Configuration(eiGlobalSiteScope).Segment("Database").KeyValue("Server")

This assigns the value of the Server setting in the [Database] section of Eiglobal.ini to the sServerName variable.