Share via

CheckScanner.FileId Property

  • Article

2/27/2008

Gets or sets the file name associated with the image data file.

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

Syntax

'Declaration
Public MustOverride Property FileId As String

public abstract string FileId { get; set; }

public:
virtual property String^ FileId {
    String^ get () abstract;
    void set (String^ value) abstract;
}

/** @property */
public abstract String get_FileId ()

/** @property */
public abstract void set_FileId (String value)

public abstract function get FileId () : String

public abstract function set FileId (value : String)

Remarks

If the application chooses to create the data for FileId, it must set FileId before calling the StoreImage method. After it calls the RetrieveMemory method, FileId is set to the image data file name, if available. If the file name is not available, FileId is set to null. The FileId value is set before a DataEvent event that is delivered to the application.

If the CapAutoGenerateFileId property is set to true, the FileId is automatically generated by the service object based on the capabilities of the device when the image is scanned.

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

CheckScanner Class
CheckScanner Members
Microsoft.PointOfService Namespace
CheckScanner.CapAutoGenerateFileId Property
CheckScanner.RetrieveImage Method
CheckScanner.StoreImage Method
CheckScanner.RetrieveMemory Method