CustomProcessUI_GetProperty Function

Applies To: Implementing a custom process

Get a property from the user interface class.


string GetProperty(string name);


[in] parName

String containing the name of the property.

The client handle is not supposed to be used after the cleanup function. This is generally the last function called for one particular client handle.

Return Value

String containing the value of the property.

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 string GetProperty(string name)


    return "";


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_Init, CustomProcessUI_ShowModalDialog, CustomProcessUI_GetUpdatedXML, CustomProcessUI_GetStatus, CustomProcessUI_SetProperty, CustomProcessUIForm_GetUpdatedXML, CustomProcessUIForm_Init