From 11:00 PM CDT Friday, Nov 8 - 2:30 PM CDT Saturday, Nov 9, ni.com will undergo system upgrades that may result in temporary service interruption.

We appreciate your patience as we improve our online experience.

NI TestStand

cancel
Showing results for 
Search instead for 
Did you mean: 

Sequence file documentation

Is there a way to dynamically create the sequence file documentation?

0 Kudos
Message 1 of 2
(2,368 Views)

I assume that by dynamically, you mean programmatically. And by documentation, I assume that you mean the equivalent of using the tool available in the TestStand sequence editor: Tools -> Sequence File Documentation.

 

If my assumptions are right, the answer is yes.

 

The documentation of the current sequence file is generated by the tool using sequence files located in <TestStand>/Components/Tools/DocGen. You can call the sequences of those sequence files to generate the documentation of a sequence file.

 

As an example, you can do the following (assuming here that you use the documentation options of the TestStand sequence editor).

 

*** Load Documentation Options ***

 

You need to create a DocOptions container custom type, available in docgen.seq.

 

DLL call from DocSupport.dll (located in the DocGen/Win32 directory), ReadDocOptions with RunState.Engine and Locals.DocOptions as parameters.

 

You can modify the options here as needed.

 

*** Get Reference from Sequence file ***

 

Create a local variable SequenceFileRef as object reference.

 

Use RunState.Sequencefile if you want to document the sequence file currently loaded or RunState.Engine.GetSequenceFileEx(Locals.SequenceFilePath) where the Local variable SequenceFilePath is a string containing the path of the sequence file you want to document.

 

*** Generate Documentation ***

 

Call the sequence "Sequence File Doc" from the sequence file docgen_html.seq or dog_text.seq if you want to generate html or ascii documentation respectively using Locals.Options and Locals.SequenceFileRef.AsPropertyObject as parameters.

 

*******************

 

I have attached the code. Up to you to modify your Documentation Options and the sequence filename according to your needs.

 

 

Marc Dubois
0 Kudos
Message 2 of 2
(2,323 Views)