mpiMapGetUniqueMapInstance
The C API uses different map object methods, including mpiMapGetUniqueMapInstance.
If the map instance is not set before you run the map, HCL Link automatically assigns a unique integer as the map instance number. However, if an API user uses HCL Link Object Pools, the unique map instance must be assigned through the API code. This method obtains the unique map instance value and sets the MPIP_MAP_INSTANCE property with this unique value.
To call this method in C++:
int mpiMapGetUniqueMapInstance()
To call this method in Java:
int MMap.getUniqueMapInstance()
Inputs
- None.
Outputs
- Unique Map Instance Number
- Integer representing the unique instance number of the map. This method does not assign the integer number but rather returns it. The map instance number is assigned by setting the map integer property MPIP_MAP_INSTANCE to the value returned by this call.
Returns
Unique integer that represents the map instance.