VS:GetDashStyleN

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

Description

Function GetDashStyleN searches for the pattern specified by the parameters. If it exists, then the negative value of the dash pattern's internal index is returned. If it does not exist, then it is added to the document and the negative value of the dash pattern's internal index is returned.

FUNCTION GetDashStyleN(
            swt        :BOOLEAN;
            numPairs   :INTEGER;
            pair1      :REAL;
            pair2      :REAL;
            pair3      :REAL;
            pair4      :REAL;
            pair5      :REAL) : LONGINT;

def vs.GetDashStyleN(swt, numPairs, pair1, pair2, pair3, pair4, pair5):
    return LONGINT

Parameters

swt		BOOLEAN
numPairs		INTEGER
pair1		REAL
pair2		REAL
pair3		REAL
pair4		REAL
pair5		REAL

Remarks

Searches for the pattern specified by the parameters. If it exists, then the negative value of the dash pattern's internal index is returned. If it does not exist, then it is added to the document and the negative value of the dash pattern's internal index is returned.

Example

currLS:=GetDashStyleN;

Version

Availability: from Vectorworks 2019