Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 1.21 KB

GetDescriptionText.md

File metadata and controls

53 lines (42 loc) · 1.21 KB

GetDescriptionText

Description

Retrieves any description text that exists for a specified object and passes it back in the descriptionText argument. The descriptionText argument will be empty if the object has no description text.

PROCEDURE GetDescriptionText(
				hObject             : HANDLE;
				VAR descriptionText : DYNARRAY[] of CHAR);
def vs.GetDescriptionText(hObject):
    return descriptionText

Parameters

Name Type Description
hObject HANDLE Handle of object for which to retrieve the text.
descriptionText DYNARRAY[] of CHAR Object's description text, if any exists.

Remarks

Added for T01363 to add descriptions for classes and layers.

Examples

PROCEDURE GetDescExample;
VAR
	descriptionTextDyn	:DYNARRAY [] of CHAR;
	tempH : HANDLE;
BEGIN
	tempH := GetObject ('Dimension');

	GetDescriptionText (tempH, descriptionTextDyn);

	IF descriptionTextDyn <> ''  THEN 
		Message (descriptionTextDyn)
	ELSE
		Message ('no description');
END;
Run (GetDescExample);

See Also

VS Functions: SetDescriptionText

Version

Availability: from Vectorworks 2015

Category