FCIFlushFolder function (fci.h)
The FCIFlushFolder function forces the current folder under construction to be completed immediately.
Syntax
BOOL DIAMONDAPI FCIFlushFolder(
[in] HFCI hfci,
[in] PFNFCIGETNEXTCABINET pfnfcignc,
[in] PFNFCISTATUS pfnfcis
);
Parameters
[in] hfci
A valid FCI context handle returned by the FCICreate function.
[in] pfnfcignc
Pointer to an application-defined callback function to obtain specifications on the next cabinet to create. The function should be declared using the FNFCIGETNEXTCABINET macro.
[in] pfnfcis
Pointer to an application-defined callback function to update the user. The function should be declared using the FNFCISTATUS macro.
Return value
If the function succeeds, it returns TRUE; otherwise, FALSE.
Extended error information is provided in the ERF structure used to create the FCI context.
Remarks
The FCIFlushFolder API forces the folder currently under construction to be completed immediately; effectively resetting the compression history if a compression method is in use.
The callback function indicated by GetNextCab will be called if the cabinet overflows, which occurs if the pending data buffered inside an FCI causes the application-specified cabinet media size to be exceeded.
Requirements
Requirement | Value |
---|---|
Target Platform | Windows |
Header | fci.h |
Library | Cabinet.lib |
DLL | Cabinet.dll |
See also
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for