VS:GetFilesInFolder: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
No edit summary
Line 5: Line 5:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<desc>
<desc>
Returns the name of the file at the index position in a folder.
Returns the Nth filename in a folder.</desc>
</desc>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<def>
<def>
<funcDef lang="vs">
<funcDef lang="vs">
FUNCTION GetFilesInFolder(folderName :STRING; index :INTEGER) :STRING;
FUNCTION GetFilesInFolder(folderName:STRING; index:INTEGER) : STRING;
</funcDef>
</funcDef>
<funcDef lang="py">
<funcDef lang="py">
Line 34: Line 33:
</lineList>
</lineList>
</params>
</params>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<return>
<remark></remark>
</return>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<remark>
<sample></sample>
On the Mac, folderName has to use colons as sub-folder delimiters.
</remark>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<sample>
<seeAlso></seeAlso>
<code lang="pas">
PROCEDURE Example;
VAR
  promptStr :STRING;
  folderName :STRING;
  result :INTEGER;
  index :integer;
BEGIN
  promptStr := 'Select the folder...';
  folderName := GetFolderPath(2);
  result := GetFolder(promptStr, folderName);
  index := 1;
  Rewrite('MyOutPut.txt');
  WHILE GetFilesInFolder(folderName, index) <> '' DO BEGIN
      WriteLn(GetFilesInFolder(folderName, index));
      index := index + 1;
  END;
  Close('MyOutPut.txt');
END;
RUN(Example);</code>
 
</sample>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<version>
<version>
Availability: from All Versions
Availability: from Vectorworks 2014


This is drop-in function.
</version>
</version>
-----------------------------------------------------------------------------------------------------------
<seeAlso>
</seeAlso>


</vwDoc>
</vwDoc>

Revision as of 17:38, 18 September 2013

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

Description

Returns the Nth filename in a folder. 

FUNCTION GetFilesInFolder(
              folderName   :STRING;
              index        :INTEGER) : STRING;
def vs.GetFilesInFolder(folderName, index):
    return STRING

Parameters

folderName STRING
index INTEGER

Version

Availability: from Vectorworks 2014

Retrieved from "http://developer.vectorworks.net/index.php?title=VS:GetFilesInFolder&oldid=17414"