Table 7- 114 Setipsuite() - .Net (C#) - Siemens Simatic S7-1500 Function Manual

User interfaces (API)
7.6 API IInstances

Table 7- 114 SetIPSuite() - .NET (C#)

Syntax
Parameters
Return values
Exceptions
GetStoragePath()
Returns the full directory in which the instance stores its data.
Table 7- 115 GetStoragePath() - Native C++
Syntax
Parameters
Return values
140
void SetIPSuite(
UInt32 in_InterfaceID,
SIPSuite4 in_IPSuite,
bool in IsRemanent );
•
UInt32 in_InterfaceID:
The ID of the network interface.
•
SIPSuite4 in_IPSuite:
If the communication interface is "Softbus", the subnet mask and standard
gateway are ignored.
•
bool in_IsRemanent:
If , the IP suite is saved after restart of the virtual controller.
true
If the communication interface is "Softbus", this flag is ignored.
None
Siemens.Simatic.Simulation.Runtime.SimulationRuntimeException
Runtime error code
ERuntimeError-
Code.InterfaceRemoved
ERuntimeErrorCode.Timeout
ERuntimeError-
Code.InstanceNotRunning
ERuntimeErrorCode.DoesNotExist
ERuntimeError-
Code.InvalidOperatingState
ERuntimeErrorCode GetStoragePath(
WCHAR inout_StoragePath[],
UINT32 in_ArrayLength
);
•
WCHAR inout_StoragePath[]:
A user-allocated storage for the storage path. The length of the array should be
at least as long as
DSTORAGE_PATH_MAX_LENGTH
•
UINT32 in_ArrayLength:
Length of the array (Wide character)
Runtime error code
SREC_OK
SREC_INTERFACE_REMOVED
SREC_TIMEOUT
SREC_INDEX_OUT_OF_RANGE
Condition
The instance is not registered in Runtime
Manager.
The function does not return on time.
The process of the virtual controller is not
running.
There is no network interface with this ID.
The virtual controller has not yet com-
pleted the boot process or is already in
the shutdown phase.
. See Data types (Page 279).
Condition
The function is successful.
The instance is not registered in Runtime
Manager.
The function does not return on time.
The path does not fit in the storage.
S7-PLCSIM Advanced
Function Manual, 12/2017, A5E37039512-AB