System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
Return value
Value of the attribute in the data type "double"
GetPropWord
Function
Specifies the current status of a property of the data type "long".
Syntax
long GetPropWord(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName)
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1151
Return value
Value of the attribute in the type "long"
state
State - short description
The properties of status displays can be modified or called in using the functions in the State
group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a
selected function is used as a template in the example. This example must be adapted as
well.
GetBasePicReferenced
Function
Specifies whether the basic picture is referenced for the status display.
Syntax
BOOL GetBasePicReferenced(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The basic picture was not stored in the object.
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1152
System Manual, 11/2008,
FALSE
The basic picture was stored in the object.
GetBasePicTransColor
Function
Specifies the transparent color of the basic picture for the status display.
Syntax
long int GetBasePicTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Transparent color of the basic picture as numeric value
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1538)
GetBackColor example (Page 1474)
GetBasePicture
Function
Specifies the basic picture name fur the status display.
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1153
Syntax
char* GetBasePicture(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Basic picture name for the status display
GetBasePicUseTransColor
Function
When using the status display, it specifies whether the transparent color is used for the basic
picture.
Syntax
BOOL GetBasePicUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Transparent color is used for the basic picture.
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1154
System Manual, 11/2008,
FALSE
Transparent color is not used for the basic picture.
GetFlashFlashPicture
Function
Specifies whether the flash picture of the status display is animated dynamically or statically.
Syntax
BOOL GetFlashFlashPicture(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The flash picture is animated dynamically.
FALSE
The flash picture is animated statically.
GetFlashPicReferenced
Function
Specifies whether the flash picture is referenced for the status display.
Syntax
BOOL GetFlashPicReferenced(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1155
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The flash picture was not stored in the object.
FALSE
The flash picture was stored in the object.
GetFlashPicTransColor
Function
Specifies the transparent color of the flash picture for the status display.
Syntax
long int GetFlashPicTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Transparent color of the flash picture as numeric value
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1156
System Manual, 11/2008,
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1538)
GetBackColor example (Page 1474)
GetFlashPicture
Function
Specifies the flash picture name for the status display.
Syntax
char* GetFlashPicture(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Flash picture name (file name of the graphic)
GetFlashPicUseTransColor
Function
When using the status display, it specifies whether the transparent color is used for the flash
picture.
Syntax
BOOL GetFlashPicUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1157
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Transparent color is used for the flash picture.
FALSE
Transparent color is not used for the flash picture.
GetFlashRateFlashPic
Function
Specifies the flash frequency of the flash picture for the status display.
Syntax
long int GetFlashRateFlashPic(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Flash frequency of a flash picture as numeric value
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1158
System Manual, 11/2008,
Note
Since the flashing is performed by means of software engineering, the precise frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM
size, update time etc.).
See also
Flash frequencies (Page 1536)
GetFlashRateFlashPic example (Page 1478)
GetIndex
Function
Specifies the index of the current position in a polygon or polygon line.
Specifies the index of the current field for check boxes and radio boxes.
Syntax
long int GetIndex(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Index of the current point or field
style
Style - short description
Various properties affecting the appearance of objects can be modified or called in using the
functions in the Style group.
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1159
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a
selected function is used as a template in the example. This example must be adapted as
well.
GetBackBorderWidth
Function
Specifies the frame width of 3D frames and slider objects.
Syntax
long int GetBackBorderWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value for the frame width of 3D frames and slider objects
See also
GetBorderStyle example (Page 1475)
GetBorderEndStyle
Function
Specifies the type of line end.
Syntax
long int GetBorderEndStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
ANSI-C function descriptions
3.3 Internal functions
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1160
System Manual, 11/2008,