Using the Toolkit

This section identifies the prerequisites for developing with the Workplace Application Integration Toolkit and describes how to view and use the interfaces and methods contained in the Toolkit from within the Microsoft® Visual Studio .NET development environment:

Required Import Files

In order to use any of the interfaces and methods contained in the Toolkit from within Visual Studio, the following TLB and DLL files must be imported in the project header file StdAfx.h, and must be specified in the following order:

#import "C:\Program Files\FileNet\AppInt\FnAppIntCmd.tlb"                      named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntHttpRequest.dll"              named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntBrowserDlg.dll"               named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntHttpConnection.dll"           named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntResources.dll"                named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntClientRecordBase.tlb"         named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntClientStore.dll"              named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntSession.dll"                  named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntSessionLogin.dll"             named_guids no_namespace

Command-Specific Import Files

In addition to the required import files, every command to be used also requires the specification of two DLLs: FnAppIntCmdComponents.dll and the DLL which contains the interface and coclass definitions for that command. For example, in order to use the Download and Upload commands, the following DLLs must be imported in StdAfx.h. These files should appear in the header file after the required import files and the command-specific DLL(s) should be specified after FnAppIntCmdComponents.dll, as follows:

#import "C:\Program Files\FileNet\AppInt\FnAppIntCmdComponents.dll"            named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntDownloadCmd.dll"              named_guids no_namespace
#import "C:\Program Files\FileNet\AppInt\FnAppIntUploadCmd.dll"                named_guids no_namespace

Each command component topic in this document identifies the DLLs required to use that command.

Statement Completion in Visual Studio

In order to be able to see the list of available methods for a given Toolkit interface, as well as the associated parameter syntax for each method, the following Option settings must be enabled (checked) in Visual Studio:

To see the list of available methods for an interface:

Tools > Options > Text Editor > Basic > General, Statement Completion: Auto list members

To see the parameter syntax for a method:

Tools > Options > Text Editor > Basic > General, Statement Completion: Parameter information

Type Libraries in the ITypeLib Viewer

The ITypeLib Viewer in Visual Studio can be used to view the COM Servers, interfaces, properties and methods contained in the Workplace Application Integration Toolkit type libraries. Once the Toolkit has been installed and the type library files registered, a type library can be viewed by performing the following:

  1. Click Tools > OLE/COM Object Viewer.
  2. Navigate to the Type Libraries folder.
  3. Open one of the FileNet type libraries in the ITypeLib Viewer by double-clicking on a Toolkit type library name, such as "FnAppIntDownloadCmd 1.0 Type Library (Ver 1.0)" or "FileNet P8 FnAppIntCmd 1.0 Type Library (Ver 1.0)".
    NOTE For a complete list of the Toolkit DLLs which are described by the type libraries, see Installed Files.
  4. In the ITypeLib Viewer, view the COM Servers and definitions for the methods, properties, and coclasses of the interface.

Unsupported Interface Members

CAUTION Only the methods discussed in this help document are guaranteed to be supported by FileNet. Therefore, customers are recommended to not use any undocumented members of an interface, as they may be changed or removed in future releases.