Stage command API wizard

Pipelines v2.1

 

This version of Pipelines contains a Microsoft Visual Studio VC++ 9.0 wizard; which creates a fully functioning skeletal Pipelines stage command DLL.

Home

 

Installing the wizard

 

Pipelines comprises a Stage command template wizard; which will enable you to create a fully functioning skeletal Pipelines Stage command. The stage that is generated by the template wizard; reads records from its primary input stream and writes records to its primary output stream.

 

There are a couple of steps that you will need to take in order to install the necessary wizard files and then to create a new Pipelines Stage command DLL. It is quite straight forward and should not take you more than a minute or two.

 

Note:

 

The default [Pipelines installation folder] is: C:\Program files\TenFiftyTwo\Pipelines\

The default [Visual Studio 2008 installation folder] is: C:\Program files\Microsoft Visual Studio 9.0\

 

1.

Copy the folder:
 
[Pipelines installation folder]\Stage command API\Pipelines Stage DLL\Scripts
 
to the folder:
 
[Visual Studio 2008 installation folder]\VC\VCWizards\
 

2.

Copy the files:
 
[Pipelines installation folder]\Stage command API\Pipelines Stage DLL\Pipelines Stage DLL.ico
[Pipelines installation folder]\Stage command API\Pipelines Stage DLL\Pipelines Stage DLL.vsz
 
to the folder:
 
[Visual Studio 2008 installation folder]\VC\vcprojects\

 

Using the wizard

 

1.

To create a new Pipelines Stage command; simply launch Visual Studio and from the File menu, select: New, then Project.

2.

Select the Visual C++ tree entry and the Pipelines Stage DLL template and in the Name and Location input fields; specify a name and location for your new stage.

 

Building your stage

 

In debug mode

 

To build a debug version of your stage; select the VS Build menu entry, then Configuration Manager… and set the build option to Debug.

When you build the Debug version of your stage; the output DLL will be written to the folder:

 

[Pipelines installation folder]\LoadLib\User\Debug\

 

In Debug mode; Pipelines will look in this folder for any user defined stages when it builds its stage command DLL list.

 

In release mode

 

To build a Release version of your stage; select the VS Build menu entry, then Configuration Manager… and set the build option to Release.

When you build the Release version of your stage; the output DLL will be written to the folder:

 

[Project location]\[Project name]\Release\

 

The Release version of your stage DLL is not automatically written the LoadLib\User\Release folder. To prevent accidental overwrite of an existing stage; the output from a Release build is always written to the projects' Release folder. In order for Pipelines to use your stage; you must copy the stage DLL to the folder:

 

[Pipelines installation folder]\LoadLib\User\Release\

 

In Release mode; Pipelines will look in this folder for any user defined stages when it builds its stage command DLL list.