VCOM:VectorWorks:Filing:IXMLFile::WriteFile

From Vectorworks Developer
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

Member of VCOM:VectorWorks:Filing:IXMLFile

Write this XML memory representation into the suplied file.

virtual VCOMError VCOM_CALLTYPE WriteFile(
IFileIdentifier* pFileID,
EXMLEncoding encoding) = 0;

Parameters

pFileID IFileIdentifier* The file that will contain the XML.
encoding EXMLEncoding Encoding that the file needs to be written into.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the fuction.
kVCOMError_Failed Routine failed.

Remarks

Supported encodings:

enum EXMLEncoding {
  eXMLEncoding_UTF8,
  eXMLEncoding_UTF16
};

See Also

VCOM:VectorWorks:Filing:IFolderIdentifier | VCOM:VectorWorks:Filing:IFileIdentifier | VCOM:VectorWorks:Filing:IXMLFile | VCOM:VectorWorks:Filing:IXMLFileNode

[[VCOM:VectorWorks:Filing:IFolderIdentifier]] | [[VCOM:VectorWorks:Filing:IFileIdentifier]] | [[VCOM:VectorWorks:Filing:IXMLFile]] | [[VCOM:VectorWorks:Filing:IXMLFileNode]]