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

3/2/2014

Renames a totals file.

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

Syntax

'Declaration
Public MustOverride Sub Rename ( _
    handle As Integer, _
    newName As String _
)

public abstract void Rename (
    int handle,
    string newName
)

public:
virtual void Rename (
    int handle, 
    String^ newName
) abstract

public abstract void Rename (
    int handle, 
    String newName
)

public abstract function Rename (
    handle : int, 
    newName : String
)

newName
The new name to be assigned to the file.The name must not exceed 10 characters. All displayable characters ( ≥ 20 hexadecimal) are valid.

If CapSingleFile is true, Rename fails.

Rename may cause a PosControlException to be thrown with one of the following ErrorCodes.

Value	Meaning
Claimed	Cannot rename because either the totals file or the totals area is claimed by another application.
Illegal	The file handle is invalid, the newName is too long or contains invalid characters, or the CapSingleFile property is TRUE.
Exists	newName already exists.

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