VS:GetMarker

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

Description

Returns marker information on the referenced object.

PROCEDURE GetMarker(
           h           :HANDLE;
           VAR start   :BOOLEAN;
           VAR end     :BOOLEAN;
           VAR style   :INTEGER;
           VAR size    :REAL);

def vs.GetMarker(h):
    return (start, end, style, size)

Parameters

h		HANDLE		Handle to the object.
start		BOOLEAN		True if a marker is visible at start of object.
end		BOOLEAN		True if a marker is visible at end of object.
style		INTEGER		Marker style:
size		REAL		Size of marker.

Remarks

OBSOLETE for VW2008: Use GetObjBeginningMarker and/or GetObjEndMarker instead.

For a one inch marker pass in a size value equal to 16384. If you pass NIL for the obj parameter, this call will set the marker defaults for this document. angle must be in range 0 to 90 degrees.

Example

VectorScript

PROCEDURE CheckMarker;
VAR
h: HANDLE;
MarkerStyle: INTEGER;
StartMark, EndMark: BOOLEAN;
Size: REAL;
BEGIN
h := FSActLayer;
GetMarker(H, StartMark, EndMark, MarkerStyle, Size);
Message('StartMark: ', StartMark, ' EndMark:', EndMark, ' MarkerStyle:', MarkerStyle, ' Size:', Size);
END;
RUN(CheckMarker);

Python

def CheckMarker():
	h = vs.FSActLayer()
	StartMark, EndMark, MarkerStyle, Size = vs.GetMarker(h)
	vs.Message('StartMark: ', StartMark, ' EndMark:', EndMark, ' MarkerStyle:', MarkerStyle, ' Size:', Size)

CheckMarker()

Version

GetMarker is obsolete as of VectorWorks 13.0

Availability: from VectorWorks 10.0

See Also

VS Functions:

• VS:SetMarker
• GetObjBeginningMarker
• GetObjEndMarker

VS Functions:

• [[VS:SetMarker]]
• [[VS:GetObjBeginningMarker| GetObjBeginningMarker]]
• [[VS:GetObjEndMarker| GetObjEndMarker]]