CMS_ReadComprData

CryptoSys PKI Pro Manual

CMS_ReadComprData

Read and extract the decompressed contents of a CMS compressed-data file.

VBA/VB6 Syntax


Public Declare Function CMS_ReadComprData Lib "diCrPKI.dll" (ByVal strFileOut As String, ByVal strFileIn As String, ByVal nOptions As Long) As Long

nRet = CMS_ReadComprData(strFileOut, strFileIn, nOptions) As Long

C/C++ Syntax


long __stdcall CMS_ReadComprData(const char *szFileOut, const char *szFileIn, long nOptions);

Parameters

szFileOut: [in] name of output file to be created.
szFileIn: [in] name of file containing input data.
nOptions: [in] option flags:
PKI_DEFAULT (0) for default options
PKI_CMS_NO_INFLATE to extract the compressed data as is without inflation

Returns (VBA/C)

If successful, the return value is the number of bytes in the output file; otherwise it returns a negative error code.

.NET Equivalent

Cms.ReadComprData Method

C++ (STL) Equivalent

static int dipki::Cms::ReadComprData (const std::string &outputFile, const std::string &inputFile, ComprDataOptions opts=ComprDataOptions::Default_ComprDataOpt)

Python Equivalent

static Cms.read_comprdata(outputfile, inputfile, opts=ComprDataOpts.DEFAULT)

Remarks

This will read and extract the contents of a CMS compressed-data file (conventionally saved with a .p7z extension) which uses the zlibCompress algorithm. It only works in file-to-file mode. Any existing file with the same name as the parameter szFileOut will be overwritten without warning. Use the PKI_CMS_NO_INFLATE option to extract the compressed data as is without inflation.

Example

See example in CMS_MakeComprData.