Difference between revisions of "VS:IsPluginFormat"

From Vectorworks Developer
Jump to: navigation, search
m (1 revision)
(add remark: this routine is unreliable, see list of parametric records where it fails)
Line 33: Line 33:
 
<return>
 
<return>
 
Returns true if format is used by a plug-in and false if it is a regular format that may have been created by the user.</return>
 
Returns true if format is used by a plug-in and false if it is a regular format that may have been created by the user.</return>
 +
 +
-----------------------------------------------------------------------------------------------------------
 +
<remark>
 +
([[User:Orso.b.schmid|Orso]], 2014.09.22): This routine crashes VW instantly if the passed handle is NIL, be careful. It is weak, for example it fails to recognize a Door format as plug-in format, but will succeed on a window format. It seems to succeed to parse clean VS objects, but there are loads of shipped objects where this fails, for example: Spiral, Callout, North Arrow, Landscape Area, Grade Tool, Parking along Path, Parking Area, Roadway Tee, Guardrail (Curved), Graticule, Adjacent Matrix, Stacking Diagram, Space Link, Slab, Window Wall (Curved), Column, Pilaster, CW-Stair, Simple Elevator, Chain Extrude, Renderworks Camera, Human Figure, Handrail (Curved), Toilet Stall, Ceiling Grid, Seating Count, Table and Chairs, Slope Dimension, Stipple, Reference Marker, Revision Marker, Linear Marker, Repetitive Unit, and so on...
 +
</remark>
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<version>
 
<version>
Availability: from VectorWorks11.0
+
Availability: from VectorWorks 11.0
  
 
</version>
 
</version>

Revision as of 05:45, 22 September 2014

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


Description

Determines if the format node is used for the parameters of a plug-in object, plug-in tool or plug-in menu command.
FUNCTION IsPluginFormat(
theFormat  :HANDLE) : BOOLEAN;
def vs.IsPluginFormat(theFormat):
    return BOOLEAN

Parameters

theFormat HANDLE Handle to the format node in question.

Return Value

Returns true if format is used by a plug-in and false if it is a regular format that may have been created by the user.

Remarks

(Orso, 2014.09.22): This routine crashes VW instantly if the passed handle is NIL, be careful. It is weak, for example it fails to recognize a Door format as plug-in format, but will succeed on a window format. It seems to succeed to parse clean VS objects, but there are loads of shipped objects where this fails, for example: Spiral, Callout, North Arrow, Landscape Area, Grade Tool, Parking along Path, Parking Area, Roadway Tee, Guardrail (Curved), Graticule, Adjacent Matrix, Stacking Diagram, Space Link, Slab, Window Wall (Curved), Column, Pilaster, CW-Stair, Simple Elevator, Chain Extrude, Renderworks Camera, Human Figure, Handrail (Curved), Toilet Stall, Ceiling Grid, Seating Count, Table and Chairs, Slope Dimension, Stipple, Reference Marker, Revision Marker, Linear Marker, Repetitive Unit, and so on...

Version

Availability: from VectorWorks 11.0
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox