Loads V (Variant) Interface
This interface can be used to read/modify the properties of the Loads Class where the values are array-based (the value can have different formats). The structure of the interface is as follows:
void DSSLoadsV(int32_t Parameter, uintptr_t *Pointer, int32_t *Type, int32_t *Size);
In this version of the DLL the API requires 4 arguments Some of these arguments are informative while others provide data access through memory address. This avoids creating unnecessary copies of the same data across the system. The 4 arguments used in this API are:
- Parameter: Indicates the data array that wants to be accessed/written.
- Pointer: Is the pointer to the array structure.
- Type: Is the type of data contained in the structure, it can be one of: 0 - Boolean, 1- Integer (32 bit), 2- double (64 bit), 3- Complex, 4- String.
- Size: Is the size in Bytes of the structure, it only considers the elements inside the structure without the identifiers added by DSS. In the case of array of strings includes the null byte (0) between the elements of the array.
The return values depend on the given Parameter, which can be one of the following:
Parameter 0: Loads.AllNames
This parameter returns a pointer to an array of bytes containing the names of all the existing Loads in the project. Each string is separated by a NULL (0) character.
Parameter 1: Loads.ZIPV - Read
This parameter returns a pointer to an array of doubles with the the array of 7 elements (doubles) for ZIP property of the active Load object.
Parameter 2: Loads.ZIPV - Write
This parameter allows to write the array of 7 elements (doubles) for ZIP property of the active Load object using the given pointer. The argument Pointer must be provided by the caller pointing to an array of doubles containing the new data. The argument mySize must also contain the length of the array of doubles.