ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Core Component API Reference / Core Component Functions Reference / Filter Functions / IG_fltr_detect_get
In This Topic
    IG_fltr_detect_get
    In This Topic

    This function checks whether the detection is enabled for the specified format and returns the format's detection priority.

    Declaration:

     
    Copy Code
    AT_ERRCODE ACCUAPI IG_fltr_detect_get(
       DWORD dwFormatID,
       LPAT_BOOL lpDetectEnable,
       LPLONG lpDetectPriority
    );
    

    Arguments:

    Name Type Description
    dwFormatID DWORD Specifies the format filter ID for which the detection flag and detection priority is retrieved. See enumIGFormats for possible values.
    lpDetectEnable LPAT_BOOL Pointer to a variable that receives the flag specifying whether or not the detection is enabled for the given format.
    lpDetectPriority LPLONG Pointer to a variable that receives the filter detection priority. The greater this value the higher the priority.

    Return Value:

    Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

    Supported Raster Image Formats:

    This function does not process image pixels.

    Sample:

    None

    Example:

     
    Copy Code
    AT_ERRCOUNT     nErrcount;            // Count of returned errors on stack
    AT_BOOL bDetectEnable;
    LONG nDetectPriority;
    nErrcount = IG_fltr_detect_get(IG_FORMAT_TIF, &bDetectEnable, &nDetectPriority);