Runtimeapientry_Initialize; Table 7- 19 Runtimeapientry_Initialize - Native C - Siemens Simatic S7-1500 Function Manual

User interfaces (API)
7.2 Initialize API
7.2.2.2

RuntimeApiEntry_Initialize

Description
Use the function
from a different directory than the directory of your application that calls this function.
When the API is initialized, the API library is first loaded and the
imported and called.
The function returns an interface to the Simulation Runtime Manager. Use this interface to
create a new instance of the virtual controller or to obtain access to an existing instance.
Table 7- 19
Syntax
Parameters
Return values
98
RuntimeApiEntry_Initialize
RuntimeApiEntry_Initialize - Native C++
__declspec(dllexport) ERuntimeErrorCode RuntimeApiEntry_Initialize(
ISimulationRuntimeManager** out_SimulationRuntimeManagerInterface,
UINT32 in_InterfaceVersion
);
•
ISimulationRuntimeManager**
out_SimulationRuntimeManagerInterface:
Pointer to a Runtime Manager interface pointer. The pointer must be initial-
ized with . The interface is created within the function. See Data types
NULL
(Page 279).
•
UINT32 in_InterfaceVersion:
Version of the API interface to be downloaded:
DAPI_DLL_INTERFACE_VERSION
Runtime error code
SREC_OK
SREC_WRONG_ARGUMENT
SREC_WRONG_VERSION
SREC_CONNECTION_ERROR
SREC_RUNTIME_NOT_AVAILABLE
only if the API library (DLL) is to be loaded
Initialize
.
Condition
The function is successful.
The pointer to the Runtime Manager interface
does not equal .
NULL
The required version of the interface is
•
incompatible with the version used to
compile the API.
The version of the API is not compatible
•
with Runtime.
See Compatibility during upgrade (Page 31).
Unable to establish a connection to the
Runtime Manager.
No Runtime Manager runs in this Windows
user session.
Function Manual, 12/2017, A5E37039512-AB
function is then
S7-PLCSIM Advanced