Installation and usage

User mode API is available for use with various development tools and platforms:

  • .NET assemblies

    .NET assemblies are available as a managed interface to the driver. The assemblies are shipped for 32-bit and 64-bit versions of Windows.
    Each assembly includes one file, CBFSDirect2017Net.dll. It is located in the platform-specific subfolder of "<CBFS Direct>\dotNET" folder. CBFSDirect2017Net.dll requires MSVC Runtime DLLs. Please refer to Deployment instructions for details on installing those Runtime DLLs on your system for development and on target systems during deployment.

    CBFSDirect class can't be installed to Toolbox as it doesn't contain any instance methods. All of it's methods are class methods.

    To use CBFS Direct in your project, you need to include CBFS Direct assembly to the list of project references. Then, in source file, add the following line:

    • C#:
      using CBFSDirect;
    • VB.NET:
      imports CBFSDirect;
    • C++:
      #using <CBFSDirect2017.dll>

  • Windows VCL units

    To use CBFS Direct in your VCL applications, just reference CBFSDirect.dcu unit in your code.
    To avoid problems with compilation of projects, which use CBFSDirect, you need to setup paths as described. By default the paths are set during installation. However if the settings were changed or installation didn't work as expected, you can use the below procedure to setup paths.

    • Delphi:
      Before using CBFS Direct in your projects, you need to tune-up global paths in Delphi IDE. Paths are set in Main menu->Tools->Environment options. Environment Options dialog appears. Find Library or Directories tab in the page control and you will find directories configuration page.
      • Set the "output directory", "unit output directory" and "BPL output directory" (if present) settings for the package to the folder, where the compiled packages will be stored after compilation.
      • add the name of the folder with CBFSDirect.dcu (<CBFS Direct>\VCL\Units\DelphiX) to the "source path" setting.

      To use CBFS Direct in your projects, you need to add "CBFSDirect" to Uses clause of one or more of your units. Then you can access CBFSDirect class and use it. You don't need to ship any external DLLs with your compiled project.

    • C++Builder:
      Before using CBFS Direct in your projects, you need to tune-up global paths in your development tool. Paths are set in Main menu->Tools->Environment options. Environment Options dialog appears. Find Library or Directories tab in the page control and you will find directories configuration page.
      • Set the "output directory", "unit output directory" and "BPL output directory" (if present) settings for the package to the folder, where the compiled packages will be stored after compilation.
      • add the name of the folder with CBFSDirect.obj and CBFSDirect.dcu (<CBFS Direct>\VCL\Units\BuilderX) to the "include path" and "library path" settings.

      To use CBFS Direct in your projects, you need to include "CBFSDirect.h" (header file) to one or more of your files. Also, you need to add CBFSDirectBX.lib to the list of used libraries. You don't need to ship any external DLLs with your compiled project.

  • Windows Lib package

    Use library files located in <CBFS Direct>\CPP\VSxxxx folder where xxxx is the version number of Visual Studio. The licensed version comes with source code of user-mode APIs for C++, so you can rebuild it with compiler and options that you need for your project.