APUFindFileInstance() Function

Finds the first instance of the Alarm Printer using the specified .alc configuration file.

Category

View

Syntax

[Result=] APUFindFileInstance(sFilePath, iInstance);

Arguments

sFilePath

The path of the .alc configuration file for which the instance is to be found.

iInstance

An integer tag that receives the number of the instance.

Remarks

This function returns the instance number to an integer tag as the instance parameter. Use this function to initially obtain the desired instance of the Alarm Printer. The file path string match is not case-sensitive.

If no instance is found, the function returns 1 as the error code (no instance available) and writes 0 to the integer tag parameter.

Returns an integer error code.

Example

InstFound is an integer tag that receives the number of the first instance that uses the configuration file c:\MyAlarmCfg\Area1Alarms.alc.

Status = APUFindFileInstance("c:\MyAlarmCfg\Area1Alarms.alc", InstFound);

See Also

APUFindAlarmGroupInstance(), APUFindPrinterInstance(), APUGetInstanceCount(), APUIsInstanceUsed()