ShowTransfer Method

  • Article

Displays a Progress dialog box while transferring the specified Item to the local computer.

Syntax

  object.ShowTransfer( _
    Item As Item, _
    [FormatID As String,] _
    [CancelError As Boolean]) As Variant

Parameters

  • Item
    Required. Item value.

  • FormatID
    Optional. String value that specifies one of the FormatID Constants that indicates the requested image format.

    • {00000000-0000-0000-0000-000000000000}
      Default. Unspecified format.

  • CancelError
    Optional. Boolean value that indicates whether to generate an error if the user cancels the dialog box.

    • False
      Default. Do not generate an error.
    • True
      Generate an error.

Return Value

Returns an ImageFile object in the format specified in FormatID, if the device supports that format; otherwise this method uses the preferred format for this imaging device.

Remarks

Transfer is essentially a version of ShowTransfer that does not display a user interface (UI) or allow the user to cancel the transfer.

For example code, see Download New Items as They are Created in Shared Samples.

Method Information

Minimum operating systems Windows XP SP1

See Also

CommonDialog, ShowAcquireImage, ShowItemProperties, ExecuteCommand (Device), GetItem, FormatID Constants, FormatID, Item, ExecuteCommand (Item), Transfer, Item (Items)