MPQ Archives - StormLib

StormLib API Reference

SFileCloseArchive

Description

bool WINAPI SFileCloseArchive(
  HANDLE hMpq                       // Handle to an open MPQ
);

Function SFileCloseArchive closes the MPQ archive. All in-memory data are freed and also any unsaved MPQ tables are saved to the archive. After this function finishes, the hMpq handle is no longer valid and may not be used in any MPQ operations.

Note that this function calls SFileFlushArchive internally.

Parameters

hMpq: [in] Handle to an open MPQ.

Return Value

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

Availability in Storm.dll

Available in Storm.dll	Yes
Ordinal number in Storm.dll 1.00	63 (0x03F)
Ordinal number in Storm.dll 1.09	252 (0x0FC)