4D Doc Center : METHOD GET COMMENTS

4D v13.4

METHOD GET COMMENTS


METHOD GET COMMENTS ( path ; comments {; *} )

Parameter	Type	Description
path	Text, Text array	Text or Text array containing one or more method path(s)
comments	Text, Text array	Comments of designated method(s)
*	Operator	If passed = command applies to host database when executed from a component (parameter ignored outside of this context)

Description

The METHOD GET COMMENTS command returns, in the comments parameter, the comments of the method(s) designated by the path parameter.

The comments retrieved by this command are those specified in the 4D Explorer (not to be confused with lines of comments in the code that are retrieved using METHOD GET CODE):

These comments can only be generated for triggers, project methods and form methods. They contain styled text.

Note: Forms and form methods share the same comments.

You can use two types of syntaxes, based either on text arrays, or text variables:

 C_TEXT(tVpath) // text variables

 C_TEXT(tVcomments)

 METHOD GET COMMENTS(tVpath;tVcomments) // comments of a single method

 ARRAY TEXT(arrPaths;0) // text arrays

 ARRAY TEXT(arrComments;0)

 METHOD GET COMMENTS(arrPaths;arrComments) // comments of several methods

You cannot mix the two syntaxes.

If the command is executed from a component, it applies by default to the component methods. If you pass the * parameter, it accesses the methods of the host database.