Skip to content

Latest commit

 

History

History
89 lines (67 loc) · 3.04 KB

nf-fci-fciflushcabinet.md

File metadata and controls

89 lines (67 loc) · 3.04 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:fci.FCIFlushCabinet
FCIFlushCabinet function (fci.h)
The FCIFlushCabinet function completes the current cabinet.
FCIFlushCabinet
FCIFlushCabinet function [Windows API]
fci/FCIFlushCabinet
winprog.fciflushcabinet
winprog\fciflushcabinet.htm
winprog
dc586260-180e-4a6b-accf-2ddd62ac1335
12/05/2018
FCIFlushCabinet, FCIFlushCabinet function [Windows API], fci/FCIFlushCabinet, winprog.fciflushcabinet
fci.h
Windows
Cabinet.lib
Cabinet.dll
Windows
19H1
FCIFlushCabinet
fci/FCIFlushCabinet
c++
APIRef
kbSyntax
DllExport
Cabinet.dll
FCIFlushCabinet

FCIFlushCabinet function

-description

The FCIFlushCabinet function completes the current cabinet.

-parameters

-param hfci [in]

A valid FCI context handle returned by theFCICreate function.

-param fGetNextCab [in]

Specifies whether the function pointed to by the supplied GetNextCab parameter will be called.

-param pfnfcignc [in]

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.

-param pfnfcis [in]

Pointer to an application-defined callback function to update the user. The function should be declared using the FNFCISTATUS macro.

-returns

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 FCIFlushCabinet API forces the current cabinet under construction to be completed immediately and then written to disk. Further calls to FCIAddFile will result in files being added to another cabinet.

In the event the current cabinet has reached the application-specified media size limit, the pending data within an FCI's internal buffers will be placed into another cabinet.

The fGetNextCab flag determines whether the function pointed to by the GetNextCab parameter will be called. If fGetNextCab is set TRUE, GetNextCab is called to obtain continuation information. If FALSE, then GetNextCab is called only in the event the cabinet overflows.

-see-also

FCIFlushFolder