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

    This function obtains the current state of the format filter indicated by nFormatType.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_load_auto_detect_get(
       AT_MODE nFormatType,
       LPAT_BOOL lpToggle
    );
    

    Arguments:

    Name Type Description
    nFormatType AT_MODE A constant indicating the format filter for which the detection setting should be obtained. See enumIGFormats for possible values.
    lpToggle LPAT_BOOL Pointer to a variable of type AT_BOOL in which will be returned the current state of the filter: enabled (TRUE), or disabled (FALSE).

    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.

    Example:

     
    Copy Code
    BOOL      bEnabled; /* Will be TRUE if this file format can be accessed */
    AT_ERRCOUNT nErrCount = IG_load_auto_detect_get ( IG_FORMAT_TIF , &bEnabled );
    

    Remarks:

    By default, detection is enabled for all ImageGear file format filters, except TXT (ASCII) and Headerless Digital Camera RAW.

    See also function IG_load_auto_detect_set.