Skip to main content

XtfGetAvailableSpaceForAppInstallation

Gets the total number of bytes available on the specified storage device of a development console.

Syntax

Parameters

address
Type: LPCWSTR
[in] Address of the development console to check. storageName
Type: LPCWSTR
[in] The name of the storage device to check. The following values are allowed: bytes
Type: UINT64*
[out] The total number of bytes available on the storage device specified in storageName for the development console specified in address.

Return value

Type: HRESULT Returns S_OK if successful; otherwise, it returns an HRESULT error code.

Remarks

This function gets the total number of bytes available on the specified storage device for a development console, allowing a tool developer writing a custom deployment tool for the console to check that there is enough space to install an app package before starting the install process. For more information about XBOX Tools Framework (XTF) tools, see Command-line tools (NDA topic). The following code sample shows how to calculate the space required for an app package.

Requirements

Header: xtfapi.h Library: XtfApi.lib Supported platforms: Windows (for XBOX console tools)

See also

XtfConsoleControl
XBOX Tools Framework native API reference
Last modified on August 20, 2026