VS:GetDescriptionText/ja

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

Description

指定した図形に設定された任意の説明文を返します。 説明文字が設定されていない場合、”descriptionText”は空になります。

PROCEDURE GetDescriptionText(
               hObject               :HANDLE;
               VAR descriptionText   :DYNARRAY[] of CHAR);

def vs.GetDescriptionText(hObject):
    return descriptionText

Parameters

hObject		HANDLE		図形のハンドル
descriptionText		DYNARRAY[] of CHAR		図形の説明文

Example

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);

Version

Availability: from Vectorworks 2015

See Also

VS Functions:

VS:SetDescriptionText

VS Functions: [[VS:SetDescriptionText]]