KisWindowsPackageUtils Namespace Reference

Functions
QString	getPackageRoamingAppDataLocation ()
bool	isRunningInPackage ()
bool	tryGetCurrentPackageFamilyName (QString *outName)
bool	tryGetCurrentPackageFullName (QString *outName)

Function Documentation

getPackageRoamingAppDataLocation()

KRITAGLOBAL_EXPORT QString KisWindowsPackageUtils::getPackageRoamingAppDataLocation

(

)

Get the RoamingAppData location. If the current process is a packaged app, the redirected private app location is returned. Uses SHGetKnownFolderPath therefore the path uses native path separators and does not include a trailing backslash.

See also: https://docs.microsoft.com/en-us/windows/msix/desktop/desktop-to-uwp-behind-the-scenes#appdata-operations-on-windows-10-version-1903-and-later

Definition at line 205 of file KisWindowsPackageUtils.cpp.

{
    PWSTR path = nullptr;
    HRESULT result =
        SHGetKnownFolderPath(FOLDERID_RoamingAppData, KF_FLAG_RETURN_FILTER_REDIRECTION_TARGET, nullptr, &path);
    if (result != S_OK) {
        qWarning() << "SHGetKnownFolderPath returned error HRESULT:" << result;
        return {};
    }
    if (!path) {
        qWarning() << "SHGetKnownFolderPath did not return a path";
        return {};
    }
    QString appData = QString::fromWCharArray(path);
    CoTaskMemFree(path);
    return appData;
}

References KF_FLAG_RETURN_FILTER_REDIRECTION_TARGET.

isRunningInPackage()

KRITAGLOBAL_EXPORT bool KisWindowsPackageUtils::isRunningInPackage

(

)

Definition at line 108 of file KisWindowsPackageUtils.cpp.

{
    return tryGetCurrentPackageFamilyName(nullptr);
}

References tryGetCurrentPackageFamilyName().

tryGetCurrentPackageFamilyName()

KRITAGLOBAL_EXPORT bool KisWindowsPackageUtils::tryGetCurrentPackageFamilyName

(

QString *

outName

)

Definition at line 113 of file KisWindowsPackageUtils.cpp.

{
    if (!AppmodelFunctions::instance().getCurrentPackageFamilyName) {
        // We are probably on Windows 7 or earlier.
        return false;
    }
 
    std::array<WCHAR, PACKAGE_FULL_NAME_MAX_LENGTH + 1> name{}; // includes null terminator
    UINT32 nameLength = name.size();
    const LONG result = AppmodelFunctions::instance().getCurrentPackageFamilyName(&nameLength, name.data());
    if (result == APPMODEL_ERROR_NO_PACKAGE) {
        // Process not running from a package.
        return false;
    }
    if (result == ERROR_INSUFFICIENT_BUFFER) {
        // This shouldn't happen!
        qWarning() << "GetCurrentPackageFamilyName returned "
                      "ERROR_INSUFFICIENT_BUFFER, required length is"
                   << nameLength;
        if (outName) {
            *outName = QString();
        }
        return true;
    }
    if (result != ERROR_SUCCESS) {
        qWarning() << "GetCurrentPackageFamilyName returned unexpected error code:" << result;
        return false;
    }
 
    if (outName) {
        // Sanity check
        if (nameLength > name.size()) {
            qWarning() << "GetCurrentPackageFamilyName returned a length "
                          "exceeding the buffer size:"
                       << nameLength;
            nameLength = name.size();
        }
        // Exclude null terminator
        if (nameLength > 0 && name.at(nameLength - 1) == L'\0') {
            nameLength -= 1;
        }
        *outName = QString::fromWCharArray(name.data(), static_cast<int>(nameLength));
    }
    return true;
}

References APPMODEL_ERROR_NO_PACKAGE, AppmodelFunctions::getCurrentPackageFamilyName, and AppmodelFunctions::instance().

tryGetCurrentPackageFullName()

KRITAGLOBAL_EXPORT bool KisWindowsPackageUtils::tryGetCurrentPackageFullName

(

QString *

outName

)

Definition at line 159 of file KisWindowsPackageUtils.cpp.

{
    if (!AppmodelFunctions::instance().getCurrentPackageFullName) {
        // We are probably on Windows 7 or earlier.
        return false;
    }
 
    std::array<WCHAR, PACKAGE_FULL_NAME_MAX_LENGTH + 1> name{}; // includes null terminator
    UINT32 nameLength = name.size();
    const LONG result = AppmodelFunctions::instance().getCurrentPackageFullName(&nameLength, name.data());
    if (result == APPMODEL_ERROR_NO_PACKAGE) {
        // Process not running from a package.
        return false;
    }
    if (result == ERROR_INSUFFICIENT_BUFFER) {
        // This shouldn't happen!
        qWarning() << "GetCurrentPackageFullName returned "
                      "ERROR_INSUFFICIENT_BUFFER, required length is"
                   << nameLength;
        if (outName) {
            *outName = QString();
        }
        return true;
    }
    if (result != ERROR_SUCCESS) {
        qWarning() << "GetCurrentPackageFullName returned unexpected error code:" << result;
        return false;
    }
 
    if (outName) {
        // Sanity check
        if (nameLength > name.size()) {
            qWarning() << "GetCurrentPackageFullName returned a length "
                          "exceeding the buffer size:"
                       << nameLength;
            nameLength = name.size();
        }
        // Exclude null terminator
        if (nameLength > 0 && name.at(nameLength - 1) == L'\0') {
            nameLength -= 1;
        }
        *outName = QString::fromWCharArray(name.data(), static_cast<int>(nameLength));
    }
    return true;
}

References APPMODEL_ERROR_NO_PACKAGE, AppmodelFunctions::getCurrentPackageFullName, and AppmodelFunctions::instance().