VCOM:VectorWorks:Filing:IResourceFile
Jump to navigation
Jump to search
.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
static const VWIID IID_ResourceFile = { 0x2FD48797, 0x9B44, 0x43B5, { 0x93, 0xA8, 0x11, 0xB7, 0x54, 0xAD, 0x1B, 0xD9 }}; class DYNAMIC_ATTRIBUTE IResourceFile : public IVWUnknown { public: virtual VCOMError VCOM_CALLTYPE OpenRead(const TXString& fileSpecifier) = 0; virtual VCOMError VCOM_CALLTYPE Close() = 0; virtual VCOMError VCOM_CALLTYPE GetFileSize(Uint32& outSize) = 0; virtual VCOMError VCOM_CALLTYPE GetPosition(Uint32& outPosition) = 0; virtual VCOMError VCOM_CALLTYPE SetPosition(Uint32 position) = 0; virtual VCOMError VCOM_CALLTYPE SeekForward(Uint32 offset) = 0; virtual VCOMError VCOM_CALLTYPE SeekBackward(Uint32 offset) = 0; virtual VCOMError VCOM_CALLTYPE GetBytesLeft(Uint32& outBytesLeft) = 0; virtual VCOMError VCOM_CALLTYPE IsAtEndOfFile(bool& outIsEOF) = 0; virtual VCOMError VCOM_CALLTYPE Read(Uint32 bufferSize, Uint8* buffer) = 0; virtual VCOMError VCOM_CALLTYPE Read(Sint64& outValue) = 0; virtual VCOMError VCOM_CALLTYPE Read(Sint32& outValue) = 0; virtual VCOMError VCOM_CALLTYPE Read(Sint16& outValue) = 0; virtual VCOMError VCOM_CALLTYPE Read(Sint8& outValue) = 0; virtual VCOMError VCOM_CALLTYPE Read(TXString& outValue) = 0; virtual VCOMError VCOM_CALLTYPE ReadStringLine(TXString& outString) = 0; virtual VCOMError VCOM_CALLTYPE SetDefaultNewLine(ELineEndType type) = 0; }; typedef VCOMPtr<IResourceFile> IResourceFilePtr;
Members
OpenRead Close GetFileSize GetPosition SetPosition SeekForward SeekBackward GetBytesLeft IsAtEndOfFile Read Read Read Read Read Read ReadStringLine SetDefaultNewLine
Remarks
There is predefined type for smart VCOM pointer VCOMPtr to IResourceFile interface:
typedef VCOMPtr<IResourceFile> IResourceFilePtr;
Version
Available from: Vectorworks 2010
See Also
[[VCOM:VCOMPtr]]