AddVirtual Method

Adds a file placeholder to the archive.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int AddVirtual(const char* lpszPath);

Unicode (Windows)
INT AddVirtual(LPCWSTR lpszPath);

- (int)addVirtual:(NSString*)path;

#define MID_ARCHIVEWRITER_ADDVIRTUAL 5

SECUREBLACKBOXLITE_EXTERNAL int SECUREBLACKBOXLITE_CALL SecureBlackboxLite_ArchiveWriter_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.

This method returns the index of the new entry in the Files collection.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.