HardTotals.FindByIndex Method (POS for .NET v1.14 SDK Documentation)

3/2/2014

Returns the name of the totals file associated with the given index.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustOverride Function FindByIndex ( _
    index As Integer _
) As String

public abstract string FindByIndex (
    int index
)

public:
virtual String^ FindByIndex (
    int index
) abstract

public abstract String FindByIndex (
    int index
)

public abstract function FindByIndex (
    index : int
) : String

Parameters

• index
  The index of the totals file to be found.

Remarks

FindByIndex provides a means for enumerating all the totals files that are currently defined. An index of zero returns the name of the file at the first file position, with later indexes returning additional file names. The largest valid index value is one less than NumberOfFiles.

The creation and deletion of files can change the relationship between indexes and the file names, as the service object may compact or rearrange the data areas used to manage file names and attributes at these times. Therefore, the application may have to claim the device to make sure that all file names are retrieved successfully.

FindByIndex returns the hard totals filename if this is successful, and may cause a PosControlException to be thrown with one of the following ErrorCodes.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

HardTotals Class
HardTotals Members
Microsoft.PointOfService Namespace
HardTotals.Create Method
HardTotals.Find Method