CommonDialog.ShowTransfer method
Displays a Progress dialog box while transferring the specified Item to the local computer.
Syntax
pvResult = .ShowTransfer( _
ByVal Item As Item, _
[ ByVal FormatID As BSTR ], _
[ ByVal CancelError As VARIANT_BOOL ] _
) As HRESULT
Parameters
-
Item [in]
-
Type: Item*
Required. Item value.
-
FormatID [in, optional]
-
Type: BSTR
String value that specifies one of the FormatID Constants that indicates the requested image format.
Value Meaning - {00000000-0000-0000-0000-000000000000}
Default. Unspecified format. -
CancelError [in, optional]
-
Type: VARIANT_BOOL
Boolean value that indicates whether to generate an error if the user cancels the dialog box.
Value Meaning - False
Default. Do not generate an error. - True
Generate an error.
Return value
Type: VARIANT*
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 UI or allow the user to cancel the transfer.
For example code, see Download New Items as They are Created in Shared Samples.
Requirements
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2003 R2 [desktop apps only] |
| Header |
|
| IDL |
|