Skip to content

FSymDef.md

Latest commit

 

History

History
37 lines (29 loc) · 1.1 KB

FSymDef.md

File metadata and controls

37 lines (29 loc) · 1.1 KB
Raw

FSymDef

Description

Function FSymDef returns a handle to the first symbol definition in the current document's symbol library. If the symbol library is empty, the function returns NIL.

FUNCTION FSymDef : HANDLE;
def vs.FSymDef():
    return HANDLE

Remarks

If the document's level ('top level') contains only symbol folders (type 92) and the symbol definitions (type 16) are all nested in symbol folders, the routine will return the first symbol folder. Using then NextSymDef will set the list navigation on the type 92, ignoring the symbol definitions.

Examples

resultH := FSymDef;
import vs

# Function FSymDef returns a handle to the first symbol definition in the
# current document's symbol library.
objHandle = vs.FSymDef()
if objHandle is not None:
    vs.Message('Created object handle: ' + str(objHandle))

See also in tutorials: 28. Symbol Instance Schedule

Version

Availability: from All Versions

Category