ZIP.EntryExtractToMemory method |
|
Remarks
Extracts into a memory buffer a specific entry available inside a ZIP file session previously opened through the ZIP.Open method or created through the ZIP.Create method.
A successful call to this method will fire the ZipOperationStart event followed by a number of ZipOperationPerc events and finally by the ZipOperationDone event.
For further details about methods for ZIP management refer to the ZIP object.
For details about using ZIP management refer to the How to manage ZIP files tutorial.
Syntax
[Visual Basic] control.ZIP.EntryExtractToMemory ( strEntryName as String, strPassword as String, pBuffer as variant, nBufferLength as Long ) as enumErrorCodes |
[C++] short control.ZIP.EntryExtractToMemory ( LPCTSTR strEntryName, LPCTSTR strPassword, const VARIANT FAR& pBuffer, long nBufferLength ); |
Parameter |
Description |
|
|
strEntryName |
String representing the name of the entry to extract. |
strPassword |
String containing the optional password for accessing the requested entry; leave it empty if not needed. |
pBuffer |
Destination memory buffer where data of the entry are stored |
nBufferLength |
Length of the memory buffer expressed in bytes. The exact size in bytes required for storing the requested uncompressed entry can be determined through a previous call to the ZIP.EntryUncompressedSizeGet method |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |