preembed_generate_beginning_embed_point_comments_.htm
Navigation: Templates > Template Language Reference > Complete Alpha Listing >====== #PREEMBED (generate beginning embed point comments)  ====== |    |
#PREEMBED( text [, condition ] )
| #PREEMBED | Generates comments at the beginning of embed point code. |
| text | A string constant or constant expression containing the text to place in the embed point. |
| condition | An expression that, when true, allows the comments to generate. |
The #PREEMBED statement specifies that comments generate at the beginning of embed points that contain code. The output condition is usually the value of a global prompt.
The comment text may use the %EmbedID, %EmbedDescription, and %EmbedParameters built-in symbols to identify the embed point:
| %EmbedID | The current embed point's identifying symbol. |
| %EmbedDescription | The current embed point's description. |
| %EmbedParameters | The current embed point's current instance, as a comma-delimited list. |
Example:
#PREEMBED('! Before Embed Point: ' & %EmbedID & ' ' & %EmbedDescription & ' ' & |
%EmbedParameters,%GenerateEmbedComments)
See Also: #POSTEMBED ,#EMPTYEMBED
preembed_generate_beginning_embed_point_comments_.htm.txt · Last modified: 2021/04/15 15:57 by 127.0.0.1