StormLib API Reference

SFileRemoveFile

Description

bool WINAPI SFileRemoveFile(
  HANDLE hMpq,                      // Handle to the MPQ
  const char * szFileName,          // The name of a file to be removed
  DWORD dwSearchScope               // Ignored
);

Function SFileRemoveFile removes a file from MPQ. The MPQ must have been open by SFileOpenArchive or created by SFileCreateArchive. Note that this operation leaves a gap in the MPQ file. To reduce size of the MPQ, use SFileCompactArchive.

Parameters

hMpq

[in] Handle to an open MPQ. This handle must have been obtained by calling SFileOpenArchive or SFileCreateArchive.

szFileName

[in] Name of a file to be removed.

dwSearchScope

[in] This parameter is ignored in the current version of StormLib.

Return Value

When the function succeeds, it returns nonzero. On an error, the function returns false and GetLastError gives the error code.

Remarks

The function only removes file with the specified locale. Unlike SFileOpenFileEx, if the file with preset locale doesn't exist in the MPQ, the function fails. For more informations about preset locale, see SFileSetLocale.

Availability in Storm.dll

Copyright (c) Ladislav Zezula 2003 - 2010