Debugging User Filters

Debugging User Filters with FabImage Studio Running

To debug your user filters, follow the instructions below:

If the Microsoft Visual Studio solution of your user filter library is not opened, open it manually. For global user filters it is typically located in My Documents\FabImage Studio Professional\Sources\LibraryName, but can be located in any other location that you have chosen while creating the library. For local user filters, you can check the location of the solution file in the Project Explorer task pane.
Make sure that FabImage Studio is not running.
Select Debug configuration.
Go to the project properties:
Go to Debugging section:
Set Command to the executable of FabImage Studio.
Set Debugger Type to Native Only.
Set a breakpoint in your code.
Launch debugging by clicking F5.
Have your filter executed in FabImage Studio. At this point it should get you into the debugging session.

You can attach the Microsoft Visual Studio debugger to a running process. Follow the instructions below:

Run FabImage Studio and load your project.
Load solution of the User Filter in Microsoft Visual Studio.
From the Debug menu, choose Attach to Process.
In the Attach to Process dialog box, find FabImageStudio.exe process from the Available Processes list.
In the Attach to box, make sure Native code option is selected.
Press Attach button.
Set a breakpoint in your code.
Have your filter executed in FabImage Studio. At this point it should get you into the debugging session.

User filters have access to the Console window of FabImage Studio. It can be helpful during debugging user filters. To write on the Console, please use one of the functions below:
- ```
bool LogInfo (const ftl::String&amp; message);
```
- ```
bool LogWarning (const ftl::String&amp; message);
```
- ```
bool LogError (const ftl::String&amp; message);
```
Functions are declared (indirectly) in the UserFilter.h header file that should be used in every file with user filters source code.
To write messages on the Output window of the Microsoft Visual Studio, please use standard OutputDebugString function (declared in Windows.h).