VCOM:VectorWorks:Filing:IApplicationFolders::GetFileInUserRoot

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:IApplicationFolders

Get the filename in the given folder under the [User] root. This is useful for obtaining filenames to save to. 

virtual VCOMError VCOM_CALLTYPE GetFileInUserRoot(
                          EFolderSpecifier    folderSpec,
                          const TXString&     fileName,
                          IFileIdentifier**   outFileID) = 0;

Parameters

folderType EFolderSpecifier The folder class to write to
fileName const TXString& fileName The name of the file
outFileID IFileIdentifier* The resulting file identifier

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

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

See Also

VCOM:VectorWorks:Filing:IFolderIdentifier | VCOM:VectorWorks:Filing:IFileIdentifier | VCOM:VectorWorks:Filing:IApplicationFolders

[[VCOM:VectorWorks:Filing:IFolderIdentifier]] | [[VCOM:VectorWorks:Filing:IFileIdentifier]] | [[VCOM:VectorWorks:Filing:IApplicationFolders]]
Retrieved from "http://developer.vectorworks.net/index.php?title=VCOM:VectorWorks:Filing:IApplicationFolders::GetFileInUserRoot&oldid=9269"