VS:GetFolder: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (Transfer Orso to _c_) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 35: | Line 35: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<remark></remark> | <remark> | ||
([[User:CBM-c-|_c_]], 2014.03.25): This was hidden since VW 10 (NOT 2010!), so the compatibility is far more than VW 2014 only. | |||
Prompts for the selection of a folder. Defaults to the folder name in the argument list. Returns 0 if the user hits OK, and -1 if the user hits cancel. The starting VAR directoryPath is overwritten with the path of the chosen folder | |||
</remark> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<sample></sample> | <sample> | ||
See [[Python Sample Import Images as Symbols]] for example. | |||
<code lang="pas">PROCEDURE Example; | |||
VAR | |||
promptStr :STRING; | |||
directoryPath :STRING; | |||
result :INTEGER; | |||
BEGIN | |||
promptStr := 'Select the folder...'; | |||
directoryPath := GetFolderPath(3); | |||
result := GetFolder(promptStr, directoryPath); | |||
Message(directoryPath); | |||
END; | |||
Run(Example);</code> | |||
</sample> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
Latest revision as of 05:33, 30 December 2020
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Gets the path to a user selected folder
FUNCTION GetFolder(
promptStr :STRING;
VAR directoryPath :STRING) : INTEGER;
def vs.GetFolder(promptStr): return (INTEGER, directoryPath)
Parameters
promptStr STRING directoryPath STRING
Remarks
(_c_, 2014.03.25): This was hidden since VW 10 (NOT 2010!), so the compatibility is far more than VW 2014 only.
Prompts for the selection of a folder. Defaults to the folder name in the argument list. Returns 0 if the user hits OK, and -1 if the user hits cancel. The starting VAR directoryPath is overwritten with the path of the chosen folder
Example
See Python Sample Import Images as Symbols for example.
PROCEDURE Example; VAR promptStr :STRING; directoryPath :STRING; result :INTEGER; BEGIN promptStr := 'Select the folder...'; directoryPath := GetFolderPath(3); result := GetFolder(promptStr, directoryPath); Message(directoryPath); END; Run(Example);
Version
Availability: from Vectorworks 2014