get_EnableSplashScreen

Description

Retrieves a value indicating whether the packed executable displays a splash screen when it starts.
If this method returns VARIANT_TRUE, the packed application will show a splash screen during initialization before the main process begins execution.

Syntax

HRESULT get_EnableSplashScreen([out, retval] VARIANT_BOOL* pbEnabled);

Parameters

pbEnabled
Type: VARIANT_BOOL*
[out, retval] Receives VARIANT_TRUE if the packed executable displays a splash screen at startup, or VARIANT_FALSE if no splash screen is shown.

Return Value

Returns an HRESULT.

  • S_OK if the property was successfully retrieved.
  • E_POINTER if pbEnabled is null.
  • Other standard COM error codes on failure.

Example

CComPtr<IBxProject> project;
if (SUCCEEDED(BxPackerApi_CreateProject(&project))) {
    VARIANT_BOOL bSplash = VARIANT_FALSE;
    if (SUCCEEDED(project->get_EnableSplashScreen(&bSplash))) {
        wprintf(L"Splash screen is %s\n", bSplash == VARIANT_TRUE ? L"enabled" : L"disabled");
    }
}

Remarks

  • The splash screen appears before the packed executable fully initializes its virtual environment and main application logic.
  • This feature can be useful to indicate that unpacking and initialization are in progress.
  • The splash screen image and behavior may be configured via the project settings in BoxedApp Packer GUI or by setting additional properties through the API.
  • You can change this setting using put_EnableSplashScreen.

See Also