Add Documentation to custom DLL-Teststeps

[OnlyOne]

Hello,
i´ve created a a DLL and  call the functions in TestStand with the C-DLL-Adapter. This works without problems.
The question is now if it is possible to add some documentation in there? If i rightclick on an inserted step and specify module then i see all the input-parameters but without the documentation of the teststep you cant know which values are allowed.
For example is it possible to add a new button in the specify-mdoule-window which opens a pdf-file? Or something like that.
When i use the labview-adapter then the labview-documentation is seen in the specify-mdoule-window, this is missing in dll-adapter.
Any ideas?
Thanks for your help.

[GRLANDMC]

Hello OnlyOne,

as far as I'm concerned there is not direct way to influence the content of the description field through the TS API for the adapter classes.

But I would recommened one of the following:

1. Create a custom step type (Action) that you will use for calling your C/C++ DLL functions.

2. Add an edit-substep to this custom steptype through the step properties that calls the documentation for the DLL using any type of code module and name the button taht will be created in the step properties 'help'.

3. Use this custom step type and launch the help through the created button in the properties tab of this step.

Let me know if this helps or you have any more queries.

Regards,

C.L. - National Instruments Applications Engineering  

[OnlyOne]

Hello C.L.,
thank you for this idea. I tried this also and will use it if i dont find another ways.
The problem is, that while you are in "specify module" and need help, then there is no button. To do it you way i have to leave "specify module" to click the help button.
Another question: When ißm in "specify module" then i specify at the top the dll-name and in the next line i select a function.
Next to the function name on the right side is a greyed ?-button. What´s the use of it? It was never clickable here. Can i set
a function to this button?

[GRLANDMC]

Hello OnlyOne,

the '?' button is for additional information if a type library for a DLL has an associated link in it, that points to an additional help file. The documentation says:

"If a DLL type library contains links to a help file for a function, you can click the ? button to access the help".

Guess this is the only and even better way to get your task done. So if you can create DLL with separate type library with links in it, themn it should work. Will be difficult to get the info, how to include the links. Will get back to you later.

Regards, C.L.

[philfour]

hi,

the last message was posted a long time ago but it seems to be the only one talking about custom help file for each steps in Specify Module window.

I am actually looking for the exact behaviour described in the previous message: use the "?" button next to the method to open a help file for the step. The question remains: How to include the links?

I use TestStand 3.0 and wish to add help link in "Edit ActiveX/COM Call" window.

Best Regards.

P.F

[dug9000]

P.F.,

I responded to your other post on this issue at: http://forums.ni.com/ni/board/message?board.id=330&thread.id=24674

Please let me know if you need more details.

-Doug