Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to WinPhotoAcquireProgressCallBackMBS class.
WinPhotoAcquireProgressCallBackMBS.Cancelled(byref Cancelled as Boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the Cancelled method.
Cancelled: a flag that, when set to true, indicates that the operation was canceled.
WinPhotoAcquireProgressCallBackMBS.DirectoryCreated(Directory as String)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the DirectoryCreated method.
Directory: containing the directory.
WinPhotoAcquireProgressCallBackMBS.EndDelete(Result as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the EndDelete method.
Result: Specifies the result of the delete operation.
WinPhotoAcquireProgressCallBackMBS.EndEnumeration(Result as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the EndEnumeration method.
Result: Specifies the result of the enumeration operation.
WinPhotoAcquireProgressCallBackMBS.EndItemDelete(ItemIndex as Integer, Item as WinPhotoAcquireItemMBS, Result as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the EndItemDelete method.
ItemIndex: Integer value containing the item index.
Item: To the deleted WinPhotoAcquireItemMBS object.
Result: Specifies the result of the delete operation.
WinPhotoAcquireProgressCallBackMBS.EndItemTransfer(ItemIndex as Integer, Item as WinPhotoAcquireItemMBS, Result as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the EndItemTransfer method.
ItemIndex: Integer value containing the item index.
Item: Pointer to a photo acquire item object.
Result: Specifies the result of the transfer operation.
WinPhotoAcquireProgressCallBackMBS.EndSession(Result as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the EndSession method.
WinPhotoAcquireProgressCallBackMBS.EndTransfer(Result as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the EndTransfer method.
Result: Specifies the result of the transfer.
WinPhotoAcquireProgressCallBackMBS.ErrorAdvise(Result as Integer, ErrorMessage as String, MessageType as Integer, byref ErrorAdviseResult as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the ErrorAdvise method.
Result: Specifies the error that occurred.
ErrorMessage: the error message.
MessageType: What type of message. May be one of the following:
Value | Description |
AdviseMessageTypeSkipRetryCancel | Specifies that the error that occurred requires a Skip, Retry, or Cancel response. The ErrorAdviseResult parameter must be set to one of the following: AdviseResultSkip, AdviseResultSkipAll, AdviseResultRetry, or AdviseResultAbort. |
AdviseMessageTypeRetryCancel | Specifies that the error that occurred requires a Retry or Cancel response. The ErrorAdviseResult parameter must be set to one of the following: AdviseResultRetry or AdviseResultAbort. |
AdviseMessageTypeYesNo | Specifies that the error that occurred requires a Yes or No response. The ErrorAdviseResult parameter must be set to one of the following: AdviseResultYes or AdviseResultNo. |
AdviseMessageTypeOK | Specifies that the error that occurred requires an OK response. The ErrorAdviseResult parameter must be set to AdviseResultOK. |
Value | Description |
AdviseResultYes | Specifies a Yes response. Valid if MessageType is AdviseMessageTypeYesNo. |
AdviseResultNo | Specifies a No response. Valid if MessageType is AdviseMessageTypeYesNo. |
AdviseResultOK | Specifies an OK response. Valid if MessageType is AdviseMessageTypeOK. |
AdviseResultSkip | Specifies a Skip response. Valid if MessageType is AdviseMessageTypeSkipRetryCancel. |
AdviseResultSkipAll | Specifies a Skip All response. Valid if MessageType is AdviseMessageTypeSkipRetryCancel. |
AdviseResultRetry | Specifies a Retry response. Valid if MessageType is AdviseMessageTypeSkipRetryCancel or AdviseMessageTypeRetryCancel. |
AdviseResultAbort | Specifies a Cancel response. Valid if MessageType is AdviseMessageTypeSkipRetryCancel or AdviseMessageTypeRetryCancel. |
WinPhotoAcquireProgressCallBackMBS.FoundItem(Item as WinPhotoAcquireItemMBS) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
This method can be used to exclude an item from the list of items to acquire. The application provides the implementation of the FoundItem method.
Return true to exclude the item from the results of the enumeration. This would allow the caller to exclude videos or camera raw files, for instance.
WinPhotoAcquireProgressCallBackMBS.GetDeleteAfterAcquire(byref DeleteAfterAcquire as Boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
DeleteAfterAcquire: When set to true, indicates that photos should be deleted after acquisition.
WinPhotoAcquireProgressCallBackMBS.GetUserInput(UserInput as WinUserInputStringMBS, byref Result as Variant, DefaultValue as Variant)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the GetUserInput method.
Result: Variant representing the descriptive input to be obtained.
DefaultValue: Variant representing the default value of the input being requested.
If this method is implemented, the implementation should copy the value of the DefaultValue argument to the Result parameter.
If the progress dialog box is suppressed in Acquire, this method must be implemented in order to assign a default value to the Result parameter. Normally a value is supplied to Result in the course of prompting the user with the default dialog, but when the dialog is suppressed, the application must copy the value of the DefaultValue argument to the Result parameter.
WinPhotoAcquireProgressCallBackMBS.StartDelete(Source as WinPhotoAcquireSourceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The implementation of StartDelete is provided by the application.
Source: the WinPhotoAcquireSourceMBS that items are being deleted from.
WinPhotoAcquireProgressCallBackMBS.StartEnumeration(Source as WinPhotoAcquireSourceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the StartEnumeration method.
Source: the WinPhotoAcquireSourceMBS object that items are being enumerated from.
WinPhotoAcquireProgressCallBackMBS.StartItemDelete(ItemIndex as Integer, Item as WinPhotoAcquireItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the StartItemDelete method.
ItemIndex: Integer value containing the item index in the list of items to delete.
Item: The WinPhotoAcquireItemMBS object that is being deleted.
WinPhotoAcquireProgressCallBackMBS.StartItemTransfer(ItemIndex as Integer, Item as WinPhotoAcquireItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the StartItemTransfer method.
ItemIndex: Integer value containing the item index in the list of items to transfer.
Item: the WinPhotoAcquireItemMBS object that is to be transferred.
WinPhotoAcquireProgressCallBackMBS.StartTransfer(Source as WinPhotoAcquireSourceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the StartTransfer method.
WinPhotoAcquireProgressCallBackMBS.UpdateDeletePercent(Percent as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the UpdateDeletePercent method.
Percent: Integer value containing the percentage of items deleted.
WinPhotoAcquireProgressCallBackMBS.UpdateTransferPercent(Overall as Boolean, Percent as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No |
The application provides the implementation of the UpdateTransferPercent method.
Overall: Flag that, when set to TRUE, indicates that the value contained in nPercent is a percentage of the overall transfer progress, rather than a percentage of an individual item's progress.
Percent: Integer value containing the percentage of items transferred.
The items on this page are in the following plugins: MBS WinFrameworks Plugin.