Skip to content

GetName.md

Latest commit

 

History

History
74 lines (58 loc) · 2.05 KB

GetName.md

File metadata and controls

74 lines (58 loc) · 2.05 KB
Raw

GetName

Description

Function GetName returns the object name of the referenced object. The function returns "None" if the object has no object name.

A handle to layer may not passed to this routine; to obtain a layer name, use GetLName.

FUNCTION GetName(h : HANDLE): STRING;
def vs.GetName(h):
    return STRING

Parameters

Name Type Description
h HANDLE Handle to object.

Remarks

_c_ (2016.02.18): If the string 'none' is returned (and not 'None' as stated above) this is not localized. Checked in the German VW.

(Unsigned): This function is a little non-intuitive. If the namestring of object h is empty, this function returns the literal string "none". I don't know what the localization implications of this are.

If the name has been deleted it returns an empty string, so test for both (empty string or "none" string).

Examples

VectorScript

ObjectName := GetName(HandleToObject);

Python

ObjectName = vs.GetName(vs.FSActLayer())
BEGIN
	PushAttrs;
	recordName := GetName (recordH);
	upi := GetPrefReal (152);

recordName := GetName (recordH);
upi := GetPrefReal (152);

BEGIN
	j := j + 1;
	ALLOCATE gRecordN [1..j];
	gRecordN [j] := GetName (recordH);
END;
if (parentRecord != None) and (vs.GetTypeN(parentRecord) == kRecordNode):
	strParentName = vs.GetName(parentRecord)

if ( objH == None ) or ( vs.IsNewCustomObject( vs.GetName( objH ) ) ):
	containerHandle = vs.ActLayer()
else:
	containerHandle = objH

See also in tutorials: 22. Selected Objects → Worksheet Rows, 25. Geometric Property Extraction Table, 27. Formatted Wall Schedule, 30. Publish Worksheet Image on a Sheet Layer

See Also

VS Functions: SetName

Version

Availability: from All Versions

Category