APUGetConfigurationFilePath() Function

Returns the full file path of the .alc configuration file used for a query.

Category

View

Syntax

[Result=] APUGetConfigurationFilePath(iInstance, sTagFilePath);

Arguments

iInstance

The instance of Alarm Printer (0 to 15).

sTagFilePath

A message tag to retrieve the name of the file path to the configuration file the Alarm Printer instance is using.

Remarks

The file path text is returned to an message tag that you can specify as sTagFilePath parameter of this function.

Returns an integer error code.

Example

The CfgFilePath message tag receives the file path of the configuration file associated with the Alarm Printer instance contained in the Inst integer tag. For example: c:\MyAlarmCfg\Area1Alarms.alc

Status = APUGetConfigurationFilePath(Inst, CfgFilePath);

See Also

APUGetAlarmGroupText(), APUGetPrinterJobCount(), APUGetQueryAlarmState(), APUGetQueryFromPriority(), APUGetQueryProcessingState(), APUGetQueryToPriority()