StormLib API Reference

SFileAddFile

Description

bool WINAPI SFileAddFile(
  HANDLE hMpq,                      // Handle to the MPQ
  const char * szFileName,          // The name of a file to be removed
  const char * szArchivedName,      // The name under which the file will be stored
  DWORD dwFlags                     // Specifies archive flags for the file
);

This function is now obsolete and should not be used. Use SFileAddFileEx for adding files to an archive.

Function SFileAddFile adds a file to the MPQ archive. The MPQ must have been open by SFileOpenArchive or created by SFileCreateArchive. Note that this operation might cause MPQ fragmentation. 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 added to the MPQ.

szArchivedName

[in] A name under which the file will be stored into the MPQ. This does not have to be the same like the original file name.

dwFlags

[in] Specifies additional options about how to add the file to the MPQ. For more information about these flags, see SFileAddFileEx.

Return Value

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

Remarks

If MPQ_FILE_COMPRESS is set in the dwFlags parameter, the function compresses the file by a compression method previously set by SFileSetDataCompression.

Availability in Storm.dll

Copyright (c) Ladislav Zezula 2003 - 2010