Skip to main content
Open topic with navigation CAPL Functions » ISO11783 » Virtual Terminal Interaction Layer (VT IL) » VTIL_RegisterObjectPool

​
VTIL_RegisterObjectPool

Valid for: CANoe DE • CANoe4SW DE

​
Function Syntax

  • long VTIL_RegisterObjectPool(dbNode workingSetMaster, char[] objectPoolPath[], char[] versionLabel); // form 1
  • long VTIL_RegisterObjectPool(dword addressWorkingSetMaster, char[] objectPoolPath[], char[] versionLabel); // form 2
  • long VTIL_RegisterObjectPool(dbNode vt, dbNode workingSetMaster, char[] objectPoolPath[], char[] versionLabel); // form 3
  • long VTIL_RegisterObjectPool(dbNode vt, dword addressWorkingSetMaster, char[] objectPoolPath[], char[] versionLabel); // form 4

​
Description

Registers an object pool file (iop). A registered object pool can be loaded via the Load Version command. For more information see chapter Save Object Pools in VT Storage.

​
Parameters

  • vt: VT simulation node to apply the function
  • workingSetMaster: Working Set Master to which the Object Pool belongs
  • addressWorkingSetMaster: Address of the Working Set Master to which the Object Pool belongs
  • objectPoolPath: Path of an object pool file (*.iop). Path has to be absolute or relative relating to the folder of the CANoe configuration.
  • versionLabel: The Virtual Terminal IL stores the object pool with this label

​
Return Values

  • 0: Function has been executed successfully
  • < 0: An error has occurred, see IL Error Code

​
Example

Example form 3, 4 
long result;
result = VTIL_RegisterObjectPool( VT, Sprayer, "iop\\sprayerV1.iop", "sprayV1");
if (result < 0)
{
  TestStepFail("Failed to register file!");
}