VCOM:VectorWorks:Filing:IZIPFile

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::Filing

..put some descriptoin in here...

Interface

// ----------------------------------------------------------------------------------------------------
// {3D7D62FB-4D99-40F2-8E87-9994DF64ED5D}
static const VWIID IID_ZIPFile = { 0x3d7d62fb, 0x4d99, 0x40f2, { 0x8e, 0x87, 0x99, 0x94, 0xdf, 0x64, 0xed, 0x5d } };

class DYNAMIC_ATTRIBUTE IZIPFile : public IVWUnknown
{
public:
	virtual VCOMError VCOM_CALLTYPE	OpenRead(IFileIdentifier* pFileID) = 0;
	virtual VCOMError VCOM_CALLTYPE	OpenWrite(IFileIdentifier* pFileID) = 0;
	virtual VCOMError VCOM_CALLTYPE	OpenNewWrite(IFileIdentifier* pFileID) = 0;
	virtual VCOMError VCOM_CALLTYPE	Close() = 0;

	virtual VCOMError VCOM_CALLTYPE	GetSize(Uint64& outValue) = 0;

	// 'path' uses '/' delimited string to identify a file or folder within the zip file
	// empty 'path' denotes the root folder of the zip file

	virtual VCOMError VCOM_CALLTYPE	GetNextFile(const TXString& path, TXString& outPath) = 0;
	virtual VCOMError VCOM_CALLTYPE	GetNextFile(const TXString& path, const TXString& extension, TXString& outPath) = 0;

	virtual VCOMError VCOM_CALLTYPE	GetFileInfo(const TXString& path, SZIPFileInfo& outInfo) = 0;

	virtual VCOMError VCOM_CALLTYPE	GetFile(const TXString& path, IZIPFileIOBuffer* outputBuffer) = 0;
	virtual VCOMError VCOM_CALLTYPE	GetFile(const TXString& path, IFileIdentifier* outputFile) = 0;

	virtual VCOMError VCOM_CALLTYPE	AddFile(const TXString& path, IZIPFileIOBuffer* inputBuffer) = 0;
	virtual VCOMError VCOM_CALLTYPE	AddFile(const TXString& path, IFileIdentifier* inputFile) = 0;

	virtual VCOMError VCOM_CALLTYPE	RemoveFile(const TXString& path) = 0;
	virtual VCOMError VCOM_CALLTYPE	MoveFile(const TXString& path) = 0;
};
typedef VCOMPtr<IZIPFile>		IZIPFilePtr;

Members

OpenRead
OpenWrite
OpenNewWrite
Close
GetSize
GetNextFile
GetNextFile
GetFileInfo
GetFile
GetFile
AddFile
AddFile
RemoveFile
MoveFile

Remarks

There is predefined type for smart VCOM pointer VCOMPtr to IZIPFile interface:

typedef VCOMPtr<IZIPFile>  IZIPFilePtr;

Version

Available from: Vectorworks 2010

See Also

VCOM:VCOMPtr

[[VCOM:VCOMPtr]]