StormLib API Reference

SFileExtractFile

Description

bool WINAPI SFileExtractFile(
  HANDLE hMpq,                      // Handle to a file or archive
  const char * szToExtract,         // Name of the file to extract
  const char * szExtracted          // Name of local file
  DWORD dwSearchScope               // Search scope
);

Function SFileExtractFile extracts one file from an MPQ archive.

Parameters

hMpq

[in] Handle to an open MPQ archive.

szToExtract

[in] Name of a file within the MPQ that is to be extracted.

szExtracted

[in] Specifies the name of a local file that will be created and will contain data from the extracted MPQ file.

dwSearchScope

[in] This parameter refines the definition of what to extract. See SFileOpenFileEx for more information.

Return Value

If the MPQ file has been successfully extracted into the target file, the function returns true. On an error, the function returns false and GetLastError returns an error code.

Availability in Storm.dll

Copyright (c) Ladislav Zezula 2003 - 2010