IAppxPackageReader::GetPayloadFile method (appxpackaging.h)
Retrieves a payload file from the package.
Syntax
HRESULT GetPayloadFile(
[in] LPCWSTR fileName,
[out, retval] IAppxFile **file
);
Parameters
[in] fileName
Type: LPCWSTR
The name of the payload file to be retrieved.
[out, retval] 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 |
|---|---|
|
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Target Platform | Windows |
| Header | appxpackaging.h |