James Hawkins : cabinet: Add documentation for FDITruncateCabinet.

[Alexandre Julliard]

Module: wine
Branch: refs/heads/master
Commit: 362aa36d0956f8bb68f49e7b85523d26b0da7834
URL:    http://source.winehq.org/git/?p=wine.git;a=commit;h=362aa36d0956f8bb68f49e7b...

Author: James Hawkins 
Date:   Wed Jan 11 12:12:54 2006 +0100

cabinet: Add documentation for FDITruncateCabinet.

---

dlls/cabinet/fdi.c |   16 +++++++++++++++-
 1 files changed, 15 insertions(+), 1 deletions(-)

diff --git a/dlls/cabinet/fdi.c b/dlls/cabinet/fdi.c
index 20d00fd..136cf27 100644
--- a/dlls/cabinet/fdi.c
+++ b/dlls/cabinet/fdi.c
@@ -2819,7 +2819,21 @@ BOOL __cdecl FDIDestroy(HFDI hfdi)
 /***********************************************************************
  *		FDITruncateCabinet (CABINET.24)
  *
- * Undocumented and unimplemented.
+ * Removes all folders of a cabinet file after and including the
+ * specified folder number.
+ * 
+ * PARAMS
+ *   hfdi            [I] Handle to the FDI context.
+ *   pszCabinetName  [I] Filename of the cabinet.
+ *   iFolderToDelete [I] Index of the first folder to delete.
+ * 
+ * RETURNS
+ *   Success: TRUE.
+ *   Failure: FALSE.
+ * 
+ * NOTES
+ *   The PFNWRITE function supplied to FDICreate must truncate the
+ *   file at the current position if the number of bytes to write is 0.
  */
 BOOL __cdecl FDITruncateCabinet(
    HFDI    hfdi,