get_SplashScreenPath

Description

Retrieves the path to the image file that is used as the splash screen for the packed executable.
If this property is set, the image specified at that path will be displayed briefly when the packed application starts.

This feature is typically used to show a logo or loading screen during application initialization.

Syntax

HRESULT get_SplashScreenPath([out, retval] BSTR* pbstrValue);

Parameters

pbstrValue
Type: BSTR*
[out, retval] Receives a string containing the path of the image file used for the splash screen.

Return Value

Returns an HRESULT.

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

Example

CComPtr<IBxProject> project;
if (SUCCEEDED(BxPackerApi_CreateProject(&project))) {
    CComBSTR splashPath;
    if (SUCCEEDED(project->get_SplashScreenPath(&splashPath))) {
        wprintf(L"Splash screen path: %s\n", static_cast<LPCWSTR>(splashPath));
    }
}

Remarks

  • The splash screen image appears when the packed EXE is first executed and disappears once the main application window is ready.
  • Supported formats include .bmp, .jpg, and .png.
  • Use put_SplashScreenPath to specify a new splash screen image for the packed executable.
  • If no splash screen is specified, no image will be displayed at startup.

See Also