ProcUnit::GetUnitTitle

Gets title name of a processing unit

int GetUnitTitle() {
   TCHAR        *unitTitle
   int  useDefault
}

Parameters

*unitTitle	Pointer to a string for storing the processing unit title name to be obtained
useDefault	You can specify the following values: - TRUE: Returns the default name of the processing unit if the title name has not been set. - FALSE: Returns an empty string if the title name has not been set. - If the argument is not specified, the same as specifing 0.

Return Value

Returns 0 when the processing unit title name is successfully obtained.

Otherwise returns a non-zero value.

Description

Gets the processing unit title name of the relevant processing item.

Example

    int Sample::GetUnitData(ProcUnit *ptrProcUnit, int dataNo, ANYTYPE *data)
    {
        TCHAR procName[32];

        // Get the unit name

        ptrProcUnit->GetUnitTitle(procName);
    }