C Functions

image\btn_a_shg.gif image\btn_b_shg.gif image\btn_c_shg.gif image\btn_d_shg.gif image\btn_e_shg.gif image\btn_f_shg.gif image\geta_shg.gif image\gete_shg.gif image\getl_shg.gif image\geto_shg.gif image\getr_shg.gif image\gett_shg.gif image\go_shg.gif image\btn_h_shg.gif image\btn_i_shg.gif image\btn_l_shg.gif image\btn_m_shg.gif image\btn_n_shg.gif image\btn_o_shg.gif image\btn_p_shg.gif image\btn_r_shg.gif image\sa_shg.gif image\seta_shg.gif image\sete_shg.gif image\seto_shg.gif image\sets_shg.gif image\sett_shg.gif image\sh_shg.gif image\btn_t_shg.gif image\btn_u_shg.gif

Functions are in alphabetical order without taking the IN_ prefix into account. Both Windows and UNIX functions are listed. See also

 

A

IN_ActivateAllHotspots activates all hotspots on a layer

IN_ActivateHotspot activates a hotspot

IN_ActivateImagenation activates the Imagenation window

IN_AddButton  adds a command button or a separator to a button bar

IN_AddExternalCommand  adds an external command to the command table

IN_AddExternalCommandEx  adds an external command and assigns its menu label, ToolTip, and Status Bar message

IN_AddMenuItem  adds the defined command or separator to the specified menu

IN_ApproveMenuAction allows a command that has been intercepted to proceed as though it has not

IN_ArrangeDocumentWindows
displays document windows tiled, cascaded, and so on

IN_AttachPenMappingTable attaches the given pen mapping table to the specified document

IN_Autospin starts or stops Autospin in the specified document window (3D documents only)

 

B

IN_BatchSetButtonStatus  sets the status of a button without redrawing the user interface

IN_BatchSetMenuStatus  sets the status of a menu item without redrawing the user interface

 

C

IN_ChangeRaster changes the resolution, rotation, mirroring, and so on of a raster

IN_CloseAllDocumentWindows 
closes all document windows

IN_CloseDocumentWindow closes a document window

IN_CreateDocumentWindow 
creates a new document window

IN_CreatePreviewFile creates a thumbnail of a raster or vector file and stores it in a new file

IN_CropLayer crops a raster automatically or according to the given coordinates of the diagonal corners

IN_ChangeDetailLevel sets how much detail is displayed in a JPEG 2000 or MrSID file while it is open.

 

D

IN_DeleteButton  deletes the specified command or separator from a button bar

IN_DeleteHotspot removes a hotspot from the active edit layer on the current page

IN_DeleteLayer removes a layer from a document

IN_DeleteMenuItem  deletes a command from the specified menu

IN_DeleteObject removes a document, page, or layer object

IN_DeleteUserAttribute removes a user attribute from a document, page, or layer, or from Imagenation

IN_DeleteVectorObject  removes a specified vector object from a specified layer on the active page

IN_Deskew straightens a raster by a given angle or tries to straighten it automatically

IN_DespeckleEx  cleans up a raster by filling in white holes or by removing clusters of black pixels

 

E

IN_EditOperation  performs an edit operation on a specified layer

IN_EditRedo  repeats the last change made to a vector object

IN_EditUndo  reverses the last change made to a vector object

IN_EnableDragDrop  sets the "drag and drop" flags for the Imagenation window and the document windows

IN_EnableSystemMenuCommands 
sets which system commands are enabled in the Imagenation window or in a document window

IN_EndImagenation closes all document windows, forces a check in or save decision, and ends Imagenation

IN_EnumerateDocumentPens
identifies the vector pens being used in the given document object

IN_ExtractText extracts strings from text objects on an edit layer and saves them to a file

 

F

IN_FaxDocumentWindowEx faxes the contents of a document window according to the specified parameters

IN_FindTextMatch starts a text search

IN_FileUpload sends files of any allowable format from your local system onto an Internet server using either FTP or HTTP.

IN_FlushDownloadDirectory  deletes downloaded Internet files from the local temp directory

IN_FlushWorklist deletes all file names from the Work List and closes all of the open document windows

IN_FreezeUI disables and enables user input through the Imagenation user interface

IN_FtpFileDownload downloads an Internet file, using FTP, to a folder called Spicer under the system temporary folder

 

GetA

IN_GetActiveDocumentWindow 
returns the identifier of the active document window

IN_GetActiveLayer returns the identifier of the active layer or layers

IN_GetAsciiTemplateFilename 
returns the file name of the RTF file that is used as a template for loading ASCII text documents

IN_GetAvailableLanguages  returns a list of languages available for use in Imagenation

IN_GetAvailableMaskTables  returns a list of all mask tables that have been loaded

IN_GetBatchMessageMode  returns whether error and status messages are suppressed

IN_GetButtonBarDefinition  returns a list of the buttons and button separators in the specified button bar

IN_GetButtonStatus returns the status of a button

IN_GetCFGFilename returns which configuration (CFG) file is being used

IN_GetDefaultMaskTable  returns the identifier of the current mask table

IN_GetDeskewLimits returns the lower and upper bounds of the deskew angle

IN_GetDirtyDocumentWindows 
returns the number of document windows that have been changed, and their identifiers

IN_GetDirtyPageIDs returns the number of pages that have been changed, and their identifiers

IN_GetDisplayLayer returns whether a layer is currently displayed

IN_GetDocumentDirectory returns the directory that is used by default for opening and for saving documents

IN_GetDocumentID returns the root identifier of a document

IN_GetDocumentViewDocwins  
returns all of the document windows that contain views of the image in the specified document

IN_GetDocumentWindowRefresh 
returns whether the specified window ignores redraw requests

IN_GetDocumentWindows returns the identifiers of the open document windows

IN_GetDocwinIDFromHWnd returns the document window identifier for a window handle

 

GetE

IN_GetEmbeddedPenSetting returns which embedded pen settings are used by Imagenation for rendering HPGL and Calcomp vector files

IN_GetErrorMessage returns the text message that corresponds to a numerical error code

IN_GetExtDocumentWindowMode
returns whether Imagenation controls zooming,
vector drawing, and scrolling in an external document window

IN_GetFileFormat  returns the file format of the specified document, page, or layer

IN_GetFilename returns the file name of the specified document, page, or layer

IN_GetFileType  returns the file format identifier of a particular file

IN_GetFileTypeName  returns the file format string that corresponds to a file format identifier

IN_GetFirstVectorObjectID returns the identifier of the first vector object on an edit layer

IN_GetFormatAttribute  returns an attribute for a COLD file format

IN_GetFormatExtension  returns the file extension for the given format

IN_GetFormatInputScaleFactor
returns the input Scale Factor for the format specified

IN_GetFormatInputScaleToFit
returns how files of the specified format are scaled when loaded into memory

IN_GetFormatList  returns a list of valid formats for the specified file type within your version of Imagenation

IN_GetFrameHWnd returns the window handle of the Imagenation window

IN_GetHighlightBoxColor returns the color of the highlight box in the Reference window

IN_GetHotspotBLOB returns the hotspot BLOB and its size in bytes for the specified edit layer

IN_GetHotspotPromptDataFlag 
returns whether the user is prompted for data when placing a hotspot

IN_GetHWndFromDocwinID returns the window handle for a document window identifier

IN_GetIMVersion returns the Imagenation version number

IN_GetINIFilename  returns the name of the INI file that is being used by Imagenation

 

GetL

IN_GetLanguage  returns the English name and the local name of the language that is currently being used by Imagenation

IN_GetLanguageString  returns a translated string from the language table that is currently being used by Imagenation

IN_GetLayerFormat returns the file type of a layer

IN_GetLayerIDs returns the number of layers in a window, and their identifiers

IN_GetLayerInfo returns file information about a layer

IN_GetLayerProperties  returns information about the properties of the specified layer

IN_GetLayerRGBColor returns the color of a layer, expressed as an RGB value

IN_GetMailDocumentFormat  
returns the file format that documents are converted to before they are attached to an e-mail message

IN_GetMaskTableLabel  returns the label that is associated with the specified mask table

IN_GetMenuDefinition  returns a list of the command identifiers for the menu items in the specified menus

IN_GetMenuStatus returns whether a menu item is available

IN_GetMouseNotifyUnits  returns the unit of measurement that is used by the two mouse callback functions

IN_GetMRUFileLimit  returns the upper limit for the 'most recently used' list in the File menu

IN_GetNextVectorObjectID returns the identifier of the vector object that comes after the specified vector object on an edit layer

IN_GetNumberDocumentWindows 
returns the number of open document windows

IN_GetNumberLayers returns the number of layers in a page

IN_GetNumberPages returns the number of pages in a document window

 

GetO

IN_GetObjectAttribute returns the value of a vector object's attribute

IN_GetObjectFileSize  returns the file size of the given document window, document, page, or layer

IN_GetObjectMER  returns the extents (minimum enclosing rectangle--MER) of the specified object

IN_GetObjectType returns the Imagenation document type for the specified identifier

IN_GetOverwriteRaster returns whether raster cleanup commands overwrite the contents of the original document window or whether they create a new window

IN_GetPageCalibration returns the page calibration for the current page

IN_GetPageID returns the identifier of a page

IN_GetPageIDs returns the number of pages in a document window, and their identifiers

IN_GetPageNumber returns the page number of a page, given its identifier

IN_GetPagesPerSheet  returns the number of document pages that get printed on each sheet of paper

IN_GetParentID returns the identifier of the specified document object's parent object

IN_GetPermissions  returns the permissions for the specified document, page, or layer

IN_GetPrinterName returns the name, device, and driver of the current printer

IN_GetPrinterNames returns a list of all available printers

IN_GetPrinterTrayCount  returns the number of paper trays available on the current printer

IN_GetPrinterTrayID  returns the identifier of the current paper tray for the current printer

IN_GetPrinterTrayIDNames  returns the names and identifiers of all paper trays available on the current printer

IN_GetPrinterTrayIDs  returns the identifiers of all the paper trays available on the current printer

IN_GetPrinterTrayNames  returns the names of all the paper trays available on the current printer

IN_GetPrintMargins returns the current margin values and the system units used for the printed document

IN_GetPrintMode returns which part of each page will be printed

IN_GetPrintOptions returns the print options currently set in the Print dialog box

IN_GetProduct  returns the current and available product configurations

IN_GetProductIDName returns the name that is associated with the specified product identifier

 

GetR

IN_GetRasterInfoString  returns the information (or comment) string for the specified CALS or TIFF layer

IN_GetReadOnlyModsFlag returns whether the user can activate and change a layer that is of a read-only file format

IN_GetRemoveMergedLayers 
reports whether layers that are overwritten after
rasterization are also removed

IN_GetScanDlgControlState  returns the status of the specified setting (or "control") in the active Scan dialog box

IN_GetScanParameter returns the value of a scan parameter

IN_GetStampFont  returns the font that is used in stamps

IN_GetStampPageView  returns whether a stamp is displayed on the given page

IN_GetStampParameter  returns whether a stamp is displayed on-screen or when printed

IN_GetStampString  returns one of the eight possible stamp text strings

IN_GetStandardPaperSizes  returns the identifiers and labels of all standard paper sizes supported by the current printer

IN_GetState returns the value of the dirty flag for the specified object

IN_GetSymbolDirectory returns the directory in which symbols are opened and saved by default

 

GetT

IN_GetTitle returns the label of the specified document window, document, page, or layer

IN_GetTool returns which tool is selected in a window

IN_GetToolAttribute requests a tool attribute value for the identified edit layer or for future edit layers

IN_GetUIConfiguration returns the value of a specified user interface configuration feature

IN_GetUserAttribute returns the value of a user attribute

IN_GetVectorLoadRasterMapping  
returns whether
raster information is used to initialize vector mapping when a vector file is loaded

IN_GetVectorObjectCount returns the number of vector objects on the specified edit layer

IN_GetVectorObjectDescription 
returns the data description of the specified vector object

IN_GetVectorObjectDescSize returns the size, in bytes, of the data description for the specified vector object

IN_GetVectorPen  returns the color, width, units, and dashing pattern of a particular vector pen line

IN_GetVersionEx returns the full release number of Imagenation, as well as the required operating system.

IN_GetViewHairlines returns whether the Hairlines view option is enabled

IN_GetViewMonochrome returns whether the Monochrome view option is enabled

IN_GetViewRotation  returns the displayed rotation of the specified document window

IN_GetViewWireframes returns whether the Wireframes view option is enabled

IN_GetVisibleObjectMER  returns the extents (MER--minimum enclosing rectangle) of the displayed layers on the specified page

IN_GetVisiblePageArea returns the visible area of a page

IN_GetXRefPath returns the reference file search path for the specified vector file formats

IN_GetZoomFactor returns the specific scale factor, if a custom one is being used, and the coordinates of the center of scaling

 

Go

IN_GotoPage selects the page with a particular number

IN_GotoPageID selects the page with a particular identifier

IN_GotoPageRelative selects the page with a particular relative position

IN_GuessDeskewAngle returns the angle by which an image is skewed

 

H

IN_HandleExternalWindow  tells Imagenation to handle all of the events for the specified external Reference, Detail, or document window

IN_HttpFileDownload downloads an Internet file, using HTTP, to a folder called Spicer under the system temporary folder

 

I

IN_ImportLayer adds a layer to a document

IN_ImportLayerToRegion  adds a layer to the given page and fits the layer into the given rectangle

IN_ImportPage adds a file as a page in a document

IN_ImportPages adds pages from another file to the document window, or imports an entire document

IN_InterceptMenuAction intercepts the specified command

IN_IsDetailWindowVisible returns whether the Detail window is shown

IN_IsImagenationRunning returns whether Imagenation is running

IN_IsLayersWindowVisible returns whether the Layers window is shown

IN_IsMeasurementWindowVisible
requests whether the
Measurements window is displayed

IN_IsMenuBarVisible returns whether the menu bar is shown

IN_IsReferenceWindowVisible 
returns whether the
Reference window is shown

IN_IsRibbonBarVisible returns whether the View Ribbon is shown

IN_IsStatusBarVisible returns whether the Status Bar is shown

IN_IsSymbolPaletteVisible  returns whether the Symbols palette is shown

IN_IsToolBarVisible returns whether the Tool Bar is shown

 

L

IN_LayerConsolidate combines the specified edit layers

IN_LinkToDocumentWindow  links an external Reference or Detail window to an external document window

IN_LoadMaskTableFile  loads the specified file as one or more mask tables

IN_LoadPenMappingFile loads a pen mapping table into memory for internal use by Imagenation

IN_LoadPenSettings  loads vector pen settings from an initialization (.ini) file

IN_LoadResourceLibrary  loads an external resource library into memory

IN_LockImagenation locks or unlocks Imagenation in memory

 

M

IN_Merge rasterizes (or combines) layers into a new raster image

IN_Merge2  rasterizes (or combines) layers into a new raster image, and allows the brightness level to be set

IN_MoveDocumentWindow moves and resizes a document window

IN_MoveIMWindow moves and resizes the Imagenation window

IN_MoveLayer shifts a layer's position relative to another layer on the same page

IN_MoveVectorObject moves a specified vector object on the specified layer

 

N

IN_NewExternalView copies the contents of a document window to an external document window using either default or current display parameters

IN_NewLayer adds a new, empty layer to a document

IN_NewPage adds a new, empty page to a document

IN_NewView copies the contents of a document window to a new document window using either default or current display parameters

 

O

IN_OCRRegion  saves an area of the specified document window's current page to a file