Platforms to show: All Mac Windows Linux Cross-Platform

Back to WinSparkleMBS class.

WinSparkleMBS.CheckUpdateWithoutUI

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Checks if an update is available.
Example
WinSparkleMBS.CheckUpdateWithoutUI

No progress UI is shown to the user when checking. If an update is available, the usual "update available" window is shown; this function is *not* completely UI-less.
Use with caution, it usually makes more sense to use the automatic update checks on interval option or manual check with visible UI.
This function returns immediately.
This function respects "Skip this version" choice by the user.

Some examples using this method:

WinSparkleMBS.CheckUpdateWithUI

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Checks if an update is available, showing progress UI to the user.
Example
WinSparkleMBS.CheckUpdateWithUI

Normally, WinSparkle checks for updates on startup and only shows its UI when it finds an update. If the application disables this behavior, it can hook this function to "Check for updates..." menu item.

When called, background thread is started to check for updates. A small window is shown to let the user know the progress. If no update is found, the user is told so. If there is an update, the usual "update available" window is shown.
This function returns immediately.

Because this function is intended for manual, user-initiated checks for updates, it ignores "Skip this version" even if the user checked it previously.

Some examples using this method:

WinSparkleMBS.CheckUpdateWithUIAndInstall

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Checks if an update is available, showing progress UI to the user and immediately installing the update if one is available.
Example
WinSparkleMBS.CheckUpdateWithUIAndInstall

This is useful for the case when users should almost always use the newest version of your software. When called, WinSparkle will check for updates showing a progress UI to the user. If an update is found the update prompt will be skipped and the update will be installed immediately.
If your application expects to do something after checking for updates you may wish to use DidNotFindUpdate and UpdateCancelled events.

WinSparkleMBS.Cleanup

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Cleans up after WinSparkle.
Example
WinSparkleMBS.Cleanup

Should be called by the app when it's shutting down. Cancels any pending Sparkle operations and shuts down its helper threads.

Some examples using this method:

WinSparkleMBS.Initialize

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Starts WinSparkle.
Example
WinSparkleMBS.Initialize

If WinSparkle is configured to check for updates on startup, proceeds to perform the check. You should only call this function when your app is initialized and shows its main window.

This call doesn't block and returns almost immediately. If an update is available, the respective UI is shown later from a separate thread.

WinSparkleMBS.LoadLibrary(File as folderitem) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Loads the WinSparkle DLL.
Example
dim f as FolderItem = GetFolderItem("WinSparkle.dll")

if WinSparkleMBS.LoadLibrary(f) then
MsgBox "OK"
else
MsgBox "Failed to load DLL."
end if

Returns true on success.

See also:

WinSparkleMBS.LoadLibrary(Path as string) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Loads the WinSparkle DLL.
Example
if WinSparkleMBS.LoadLibrary("Libs\WinSparkle.dll") then
MsgBox "OK"
else
MsgBox "Failed to load DLL."
end if

Returns true on success.

See also:

The items on this page are in the following plugins: MBS Win Plugin.


The biggest plugin in space...