VS:Open

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Procedure Open opens a ASCII text file for reading.

Remember to use Close when you are finished reading or writing to a file.

If the filename includes a fully qualified path, the path has to use the appropriate notation for the local operating system:

<dir>Macintosh HD:Applications:VectorWorks:Plug-Ins:Data:Notes.txt</dir> <dir>C:Program FilesVectorWorksPlug-InsDataNotes.txt</dir> If the filename includes a path relative to the location of the VectorWorks executable, the subfolder delimiters have to be backslashes:

<dir>Plug-InsDataNotes.txt</dir> If the filename does not include a path, the file is assumed to exist in the same folder as the VectorWorks executable.

PROCEDURE Open(
        fileName   :STRING);

def vs.Open(fileName):
    return None

Parameters

fileName

STRING

Name of file to open.

Remarks

Absolute paths versus relative paths:

Accepts platform specific absolute paths, or windows delimited relative paths:

• VS:Append
• VS:Close
• VS:EOF
• VS:Open
• VS:Rewrite

Accepts platform specific absolute paths only:

• VS:CreateFolder
• VS:GetFilesInFolder
• VS:GetFolder

Returns platform specific absolute paths (user interactive):

• VS:GetFile
• VS:GetFileN
• VS:PutFile

Returns platform specific absolute paths (not user interactive):

• VS:GetFolderPath
• VS:GetFPathName

Example

VectorScript

PROCEDURE Example;
VAR
fileName :STRING;
BEGIN
UseDefaultFileErrorHandling(FALSE);
fileName := 'Plug-InsCommonDataCallout Prefs.txt';
Open(fileName);
AlrtDialog(Concat(GetLastFileErr));
Close(fileName);
END;
RUN(Example);

Version

Availability: from All Versions