ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Vector Component API Reference / Vector Component Functions Reference / Raster Functions / IG_vect_raster_get_filename
In This Topic
    IG_vect_raster_get_filename
    In This Topic

    This function gets the file name being attached to the raster entity.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_vect_raster_get_filename(
          HIG_VECT_ENTITY hEntity, 
          LPCHAR lpName, 
          long nSize
    );
    

    Arguments:

    Name Type Description
    hEntity HIG_VECT_ENTITY Handle to the Entity.
    lpName LPCHAR User-allocated buffer where filename is returned.
    nSize long Size of the user-allocated buffer.

    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

    Remarks:

    If no file name has been set previously, the function returns an empty string.

    If raster file name is an empty string, or starts with "data:image", SVG filter embeds raster data to the image file, otherwise it saves it in a separate file, using the format specified by IG_vect_raster_set_fileformat, and references it in the vector file.