KeyView 24.3

# KV_GetFilterInterfaceEx()

This function supplies pointers to other Filter functions. When `KV_GetFilterInterfaceEx()` is called, it assigns the function pointers in the structure `KVFltInterfaceEx` to other functions described in this chapter. For example, `KVFltInterfaceEx`.`fpInit` is assigned to point to the function `Init()`.

## Syntax

    KVErrorCode pascal KV_GetFilterInterfaceEx(
        KVFltInterfaceEx   *pInterfaceEx,
        int                 version );

## Arguments

`pInterfaceEx` | A pointer to the structure KVFltInterfaceEx, which contains function pointers that `KV_GetFilterInterfaceEx()` assigns to all other API functions.
`version` | The version number of the current Filter interface. This is a symbolic constant (`KVFLTINTERFACE_REVISION`) defined in `kvfilt.h`.

## Returns

If the revision number of the Filter interface API is unknown, this function returns a general error (`KVERR_General`).

## Discussion

- One of the initial steps in using the Filter API is to create an instance of a `KVFltInterfaceEx` structure and use this function to gain access to all other functions. The sample programs provide examples of how to do this.
- You can call the API functions directly. For example, you can call `GetOLESummaryInfo()` instead of using `fpGetOLESummaryInfo()` in `KVFltInterfaceEx`. However, OpenText recommends that you assign the function pointers in `KVFltInterfaceEx` to the functions for efficiency.

## Example

    void               *pKVFILTER;
    KVFltInterfaceEx   FilterFunc;
    KVErrorCode        nRet = KVERR_Success;
    KVErrorCode (pascal *fpGetFilterInterfaceEx)( KVFltInterfaceEx *FilterFunc, int version );

    pKVFILTER = myLoadLibrary(szDllName);

    fpGetFilterInterfaceEx = (KVErrorCode (pascal *)( KVFltInterfaceEx *, int ) )
    myGetProcAddress(pKVFILTER, "KV_GetFilterInterfaceEx");

Copyright 1997-2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.3

Topic Title: KV_GetFilterInterfaceEx()