Edit

Share via

IAppxBundleReader::GetFootprintFile method (appxpackaging.h)

  • Article

Retrieves the specified type of footprint file from the bundle.

Syntax

HRESULT GetFootprintFile(
  [in]          APPX_BUNDLE_FOOTPRINT_FILE_TYPE fileType,
  [out, retval] IAppxFile                       **footprintFile
);

Parameters

[in] fileType

Type: APPX_BUNDLE_FOOTPRINT_FILE_TYPE

The type of footprint file to be retrieved.

[out, retval] footprintFile

Type: IAppxFile**

The file object that corresponds to the footprint file of fileType.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. Otherwise, it returns an error code that includes, but is not limited to, those in the following table.

Return code Description
E_INVALIDARG
 The fileType parameter is not a valid value in the APPX_BUNDLE_FOOTPRINT_FILE_TYPE enumeration.
HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)
 The bundle doesn't contain a footprint file of the specified type.

GetFootprintFile can return this error for the APPX_BUNDLE_FOOTPRINT_FILE_TYPE_SIGNATURE type.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Target Platform Windows
Header appxpackaging.h

See also

IAppxBundleReader