Init Function

Applies To: Implementing a custom process

Initializes the class and stores the image service definition (ISDef) XML for use later if needed.

The ISDef XML contains properties for a service and will not be needed for a custom process user interface.


bool Init(string isDefXML);


[in] isDefXML

XML string representing imager service definition (ISDef) properties.

Return Value

A Boolean value signifying success.

Reporting errors and warnings: A false return value can be regarded as an error which can be obtained by calling the GetStatus function which will give out the error message for the last error in the DLL.


The following example represents a C# implementation of this function:


public bool Init(string isDefXML)


    myDialog = new CustomProcessUIForm();

    myXADefFile = System.IO.Path.Combine(SystemUtility.GetSpecialFolderPath(



    myISDefXML = isDefXML;

    return true;


For a detailed example on how to implement this function, see Sample custom process.

Related Topics

See also: CustomProcess_Create, CustomProcess_SetWindow, CustomProcess_Initialize, CustomProcess_GetRow, CustomProcess_GetMetadata, CustomProcess_GetLastError, CustomProcess_Cleanup, CustomProcess_SetCallbackFunctions, CustomProcess_SetAreaOfInterest, CustomProcessUI_ShowModalDialog, CustomProcessUI_GetUpdatedXML, CustomProcessUI_GetStatus, CustomProcessUI_GetProperty, CustomProcessUI_SetProperty, CustomProcessUIForm_GetUpdatedXML, CustomProcessUIForm_Init