IAppxPackageReader::GetPayloadFile method

Retrieves a payload file from the package.

Syntax

HRESULT GetPayloadFile(
  [in]          LPCWSTR   fileName,
  [out, retval] IAppxFile **file
);

Parameters

fileName [in]

Type: LPCWSTR

The name of the payload file to be retrieved.

file [out, retval]

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.

Remarks

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

Requirements

See also

IAppxFile

IAppxPackageReader

IAppxPackageReader::GetFootprintFile

IAppxPackageReader::GetPayloadFiles