IAppxPackageReader::GetPayloadFile method (appxpackaging.h)

Retrieves a payload file from the package.

Syntax

HRESULT GetPayloadFile(
  LPCWSTR   fileName,
  IAppxFile **file
);

Parameters

fileName

Type: LPCWSTR

The name of the payload file to be retrieved.

file

Type: IAppxFile**

The file object that corresponds to fileName.

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
HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)
There is no payload file with the specified file name.

Remarks

The specified fileName must include the path relative to the package root directory.

Requirements

   
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header appxpackaging.h

See also

IAppxFile

IAppxPackageReader

IAppxPackageReader::GetFootprintFile

IAppxPackageReader::GetPayloadFiles