VS:VerifyLibraryRoutine

From Vectorworks Developer
Revision as of 01:11, 16 June 2015 by Orso.b.schmid (Talk | contribs)

Jump to: navigation, search

.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 routine names suppressing warnings. Suppose you script for VW 2013 but wish to use a routine developed for VW 2014, normally the parser would rise the error "identifier not declared" since the routine is unknown (introduced later). If you wrap the routine call into an IF condition starting with VerifyLibraryRoutine this warning is suppressed. This is very useful for organizing libraries of algorithms spanning across different VW versions.
Warning
the warning "The function is deprecated and should not be used" can't be suppressed! This will rise upon usage of routines listed as deprecated, for example the old dialog routines: Deprecated for VW 2010 (10)
{ 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