Difference between revisions of "VS:VerifyLibraryRoutine"

From Vectorworks Developer
Jump to: navigation, search
m (1 revision)
(add remark of usability for checking future versions)
Line 37: Line 37:
 
<return>
 
<return>
 
Returns TRUE if the call is available, otherwise returns FALSE.</return>
 
Returns TRUE if the call is available, otherwise returns FALSE.</return>
 +
 +
-----------------------------------------------------------------------------------------------------------
 +
<remark>
 +
([[User:Orso.b.schmid|Orso]], 2015.06.14):  This can be used to test routines from later VW versions. Suppose you script for VW 2013 but wish to use a routine developed for VW 2014, normally the parser would rise an error. Not if you wrap the routine call into an IF condition starting with VerifyLibraryRoutine. This is very useful for libraries of algorithms:
 +
 +
<code lang="pas">
 +
{ try this in VW 18 (2013), where the routine PythonExecute would normally rise the error "identifier not declared" }
 +
IF VerifyLibraryRoutine('PythonExecute') = FALSE THEN
 +
    AlrtDialog(Concat('No, forget it, it won''t work in this VW version'))
 +
ELSE
 +
    PythonExecute('Test.py'); { PythonExecute was introduced by VW 19 (2014) }
 +
</code>
 +
 +
</remark>
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<version>
 
<version>
Availability: from VectorWorks9.0
+
Availability: from VectorWorks 9.0
  
 
</version>
 
</version>

Revision as of 13:20, 14 June 2015

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


Description

Verifies that a procedure or function call located in a VectorScript extension is registered and available for use in scripts.

Call this function prior to using any call located in a VectorScript extension to ensure successful use of the call in a script.

(A VectorScript extension is also known as an SDK Plug-in Library. It is a plug-in that is developed using the VectorWorks SDK and the C++ language. When installed in the Plug-ins folder it provides functions that may be called from VectorScript. The VerifyLibraryRoutine function allows the script to determine if the function is available.)

FUNCTION VerifyLibraryRoutine(
routineName  :STRING) : BOOLEAN;
def vs.VerifyLibraryRoutine(routineName):
    return BOOLEAN

Parameters

routineName STRING Name of function call to be verified.

Return Value

Returns TRUE if the call is available, otherwise returns FALSE.

Remarks

(Orso, 2015.06.14): This can be used to test routines from later VW versions. Suppose you script for VW 2013 but wish to use a routine developed for VW 2014, normally the parser would rise an error. Not if you wrap the routine call into an IF condition starting with VerifyLibraryRoutine. This is very useful for libraries of algorithms:
{ try this in VW 18 (2013), where the routine PythonExecute would normally rise the error "identifier not declared" }
IF VerifyLibraryRoutine('PythonExecute') = FALSE THEN
    AlrtDialog(Concat('No, forget it, it won''t work in this VW version'))
ELSE
    PythonExecute('Test.py'); { PythonExecute was introduced by VW 19 (2014) }

Version

Availability: from VectorWorks 9.0
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox