FNFCISTATUS macro

The FNFCISTATUS macro provides the declaration for the application-defined callback function to update the user.

Syntax


long FNFCISTATUS(
   UINT     typeStatus,
   ULONG    cb1,
   ULONG    cb2,
   void FAR *pv
);

Parameters

typeStatus

Indicates the type of status update. Possible values include:

ValueMeaning
statusFile

0x00

Compressing a block into a folder.
statusFolder

0x01

Adding a folder to a cabinet.
statusCabinet

0x02

Writing out a complete cabinet.

 

cb1

Indicates a status specific value. Possible values include:

ValueMeaning
statusFile

0x00

Size of the compressed block.
statusFolder

0x01

Amount of a folder copied to a cabinet thus far.
statusCabinet

0x02

Estimated cabinet size.

 

cb2

Specifies a status specific value. Possible values include:

ValueMeaning
statusFile

0x00

Size of the uncompressed block.
statusFolder

0x01

Total size of the folder.
statusCabinet

0x02

Actual cabinet size.

 

pv

Pointer to an application-defined value.

Return value

The return value is -1 if an error occurs. Any other value indicates success. If typeStatus equals statusCabinet, then the return value is as described in the Remarks below.

Remarks

If typeStatus equals statusCabinet the returned value indicates the desired size for the cabinet file. FCI updates the maximum cabinet size remaining using this returned value. This allows a client to generate multiple cabinets per disk, and have FCI limit the size accordingly.

Requirements

Header

Fci.h

See also

FCICreate

 

 

Show: