##EX Tag

The ##EX tag defines an example for use with the given procedure. The example should be valid HTML as no parsing of the content will occur.

Since the ##EX is not legal SQL syntax, it must appear between comment tags. The tag may be between multiline comment tags (/* ... */), but only the first line will be read. If the ##EX line is intended to be a multiline comment, a ##EX must appear on the line immediately before the text to form part of the comment.

Multiple lines are appended to existing lines, thus all ##EX tags will appear in the order in which they were defined in the batch.

Syntax

-- ##EX ExampleText

Where ExampleText is the text to use for the example.  

Example

-- ##EX <P>To use the update procedure, ensure that transactions are on in the calling
-- ##EX routine. The update procedure assumes it is part of a transaction and will not
-- ##EX create a new one.</P>
-- ##EX <br>
-- ##EX <P>Thus,
-- ##EX BEGIN TRANSACTION
-- ##EX EXEC UpdateProcedure
-- ##EX If @@Error = 0
-- ##EX    COMMIT TRANSACTION
-- ##EX Else
-- ##EX    ROLLBACK TRANSACTION
-- ##EX </P>

© 2001-2004 Pikauba Software. All rights reserved.