System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)

Подождите немного. Документ загружается.

SetTagSWord

Function

Sets the value of a tag of the data type "signed 16 bit".

Syntax

BOOL SetTagSWord(Tag Tag_Name, short value);

Parameters

Tag_Name

name of the tag

value

Value of the tag in the data type "short"

size

Size of the byte field in bytes

Return value

TRUE

The function itself has been completed without any errors.

However, no test is made as to whether the tag could be written without errors.

FALSE

An error has occurred.

See also

SetTagSByte example (Page 1527)

Principle of the SetTag functions (Page 1417)

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

System Manual, 11/2008,

1461

SetTagValue

Function

Enables the transfer of a value in the form of a variant and sets the pointer to the value of the

data type "Variant".

Syntax

BOOL SetTagValue(LPDM_VARKEY lpdmVarKey, LPVARIANT lpdmValue, PDWORD

dwState, LPCMN_ERROR lpdmError);

Parameters

lpdmVarKey

Pointer to a structure of the data type "DM_VARKEY"

lpdmValue

Pointer to the value of data type "Variant". A description of the data type VARIANT can be

found in the associated documentation.

dwState

Tag status which is returned after the function has been run.

lpdmError

Pointer to the structure which contains the error description

Return value

TRUE

The function itself has been completed without any errors.

However, no test is made as to whether the tag could be written without errors.

FALSE

An error has occurred.

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

1462

System Manual, 11/2008,

See also

Principle of the SetTag functions (Page 1417)

Structure definition CMN_ERROR (Page 1546)

Tag statuses (Page 1543)

Structure definition DM_VAR_UPDATE_STRUCT (Page 1548)

Structure definition DM_VARKEY (Page 1550)

SetTagWord

Function

Sets the value of a tag of the data type "unsigned 16 Bit".

Syntax

BOOL SetTagWord(Tag Tag_Name, WORD value);

Parameters

Tag_Name

name of the tag

value

Value of the tag in the data type "WORD"

Return value

TRUE

The function itself has been completed without any errors.

However, no test is made as to whether the tag could be written without errors.

FALSE

An error has occurred.

See also

SetTagWord example (Page 1528)

Principle of the SetTag functions (Page 1417)

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

System Manual, 11/2008,

1463

3.3.6 WinCC

3.3.6.1 WinCC - short description

The functions of the WinCC group allow to define various setting in Runtime.

The functions of the System subgroup can be used to influence WinCC Runtime.

Note

Various examples are offered for the function descriptions. For functions with a similar syntax,

selected function is used as a template in the example. This example must be adapted as

well.

3.3.6.2 system

DeactivateRTProject

Function

Deactivates the activated project.

Note

If Runtime is exited on a server or client this applies only to the respective computer.

An activated project for which the WinCC Explorer has not been started must be closed with

the internal function "ExitWinCC".

If the activated project was exited with the internal function "DeactivateRTProject" the WinCC

project remains open in the background. To close this project, the WinCC Explorer must be

opened and then be closed by means of the menu commands "File" > "Exit".

Syntax

BOOL DeactivateRTProject();

Return value

TRUE

The function has been completed without any errors.

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

1464

System Manual, 11/2008,

FALSE

An error has occurred.

See also

DeactivateRTProject example (Page 1473)

ExitWinCC

Function

Deactivates Runtime and exits WinCC on the computer executing the function.

Note

If Runtime is exited on a server or client this applies only to the respective computer.

An activated project for which the WinCC Explorer has not been started must be closed with

the internal function "ExitWinCC".

If the activated project was exited with the internal function "DeactivateRTProject" the WinCC

project remains open in the background. To close this project, the WinCC Explorer must be

opened and then be closed by means of the menu commands "File" > "Exit".

Syntax

BOOL ExitWinCC ();

Return value

TRUE

The function has been completed without any errors.

FALSE

An error has occurred.

See also

ExitWinCC example (Page 1474)

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

System Manual, 11/2008,

1465

GetLanguage

Function

Determines the current Runtime language.

Syntax

DWORD GetLanguage();

Return value

The current Runtime language with the associated language identifier is returned.

Note

You can find a comprehensive "Language code" table in the "Basic Principles of VBScript"

documentation under the index entry "Language code".

See also

GetLanguage example (Page 1481)

InquireLanguage

Function

Determines all languages configured in the text library for the runtime.

Use dWCount to specify where the number of determined language IDs is to be stored.

Syntax

DWORD* InquireLanguage(DWORD* dwCount);

Parameters

dwCount

Pointer to the number of determined language IDs

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

1466

System Manual, 11/2008,

Return value

The configured languages with the associated language identifiers are returned.

Note

You can find a comprehensive "Language code" table in the "Basic Principles of VBScript"

documentation under the index entry "Language code".

See also

InquireLanguage example (Page 1509)

SetLanguage

Function

Changes the language setting in Runtime.

Syntax

BOOL SetLanguage(DWORD dwLocaleID);

Parameters

dwLocaleID

Language ID of the language to be set

Return value

TRUE

The function has been completed without any errors.

FALSE

An error has occurred.

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

System Manual, 11/2008,

1467

See also

Language ID (Page 1542)

SetLanguage example (Page 1517)

3.3.6.3 FillDiagnoseInTags

Function

Activates or deactivates the storage of diagnostic information in tags.

As filling the tags is an additional load for the system, it should only be activated temporarily

for diagnostic information.

Syntax

void FillDiagnoseInTags(BOOL bfill);

Parameters

bFill

Storage of diagnostic information in tags on/off

TRUE Activate supply of diagnostic tags

FALSE Deactivate supply of diagnostic tags

Diagnostic tags of GlobalScript

@SCRIPT_COUNT_TAGS

This tag contains the current number of tags requested via Script.

@SCRIPT_COUNT_REQUEST_IN_QUEUES

This tag contains the current number of jobs.

@SCRIPT_COUNT_ACTIONS_IN_QUEUES

This tag contains the current number of actions.

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

1468

System Manual, 11/2008,

3.3.6.4 GetServerTagPrefix

Function

To be able to access tags of the respective server from a WinCC client in a distributed system,

the tag names must be supplemented with the server prefix.

If the tags are accessed by means of the functions GetTagxx or SetTagxx, the required addition

is made by the script control.

If WinCC API functions are used for accessing, the tag names have to be supplemented by

the user. The GetServer TagPrefix function provides the required prefixes.

One pointer each of the "char" type to ServerPrefix, TagPrefix and WindowPrefix is returned.

The user must neither change the memory (also no strcat) nor release it.

Syntax

void GetServerTagPrefix(char** ppszServerPrefix, char** ppszTagPrefix, char**

ppszWindowPrefix);

Parameters

ppszServerPrefix

Pointer to a pointer referring to the server prefix

ppszTagPrefix

Pointer to a pointer referring to the tag prefix

ppszWindowPrefix

Pointer to a pointer referring to the window prefix

See also

GetServerTagPrefix example (Page 1491)

GetServerTagPrefix example (Page 1492)

3.3.6.5 TraceText

Function

The value defined in <Parameter> is recorded in APDiag if the specified diagnostic level has

been reached.

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

System Manual, 11/2008,

1469

Syntax

void TraceText(DWORD dwTraceLevel, char* pszFormat, <Parameter>);

Parameters

dwTraceLevel

Diagnostic level

pszFormat

Output format (according to printf function)

Value to be reported

Note

The parameterization dialog for this function provides the selection of tags, graphic objects

and pictures.

3.3.6.6 TraceTime

Function

The value defined in <Parameter> is recorded in APDiag if the specified diagnostic level has

been reached.

In addition, the time since the AP start of diagnosis is output in milliseconds to enable

performance measurements.

Syntax

void TraceTime(DWORD dwTraceLevel, char* pszFormat, <Parameter>);

Parameters

dwTraceLevel

Diagnostic level

ANSI-C function descriptions

3.3 Internal functions

MDM - WinCC: Scripting (VBS, ANSI-C, VBA)

1470

System Manual, 11/2008,