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

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

Return value

TRUE

The function has been completed without any errors.

FALSE

An error has occurred.

SetWindowsStyle

Function

Specifies whether buttons are to be displayed in Windows style.

Syntax

BOOL SetWindowsStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL

bWindowStyle);

Parameters

lpszPictureName

Picture name

lpszObjectName

Object name

bWindowStyle

"Windows style" on/off

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,

1351

OpenHomePicture

Function

Opens the entered start picture.

Syntax

BOOL OpenHomePicture();

Return value

TRUE

The function has been completed without any errors.

FALSE

An error has occurred.

OpenNextPicture

Function

WinCC saves the names of the pictures opened by the user during runtime as well as the

sequence in which these pictures were opened.

The maximum number of picture names saved this way can be set in the WinCC Explorer in

the computer properties on the "Graphics Runtime" tab under "picture buffer size".

The OpenNextPicture function now opens the picture which was opened before the last call

of OpenPrevPicture.

Syntax

BOOL OpenNextPicture();

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)

1352

System Manual, 11/2008,

OpenPrevPicture

Function

WinCC saves the names of the pictures opened by the user during runtime as well as the

sequence in which these pictures were opened.

The maximum number of picture names saved this way can be set in the WinCC Explorer in

the computer properties on the "Graphics Runtime" tab under "picture buffer size".

The OpenPrevPicture function now opens the picture which was opened before the currently

open picture.

Syntax

BOOL OpenPrevPicture();

Return value

TRUE

The function has been completed without any errors.

FALSE

An error has occurred.

OpenStoredPicture

Function

Opens the picture saved with the StorePicture function.

Syntax

BOOL OpenStoredPicture();

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,

1353

StorePicture

Function

Saves the current picture which can then be opened with the OpenStoredPicture function.

Syntax

BOOL StorePicture();

Return value

TRUE

The function has been completed without any errors.

FALSE

An error has occurred.

3.3.5 tag

3.3.5.1 tag - short description

Tags can be set or called in using the functions from the tag group.

GetTag or GetTagWait?

Process tags that are called with GetTag are put in an image. Since updating and reading the

image is done in two separate procedures, the GetTag call is not directly influenced by the

coupling. It can therefore be executed quicker and more independently than a GetTagWait

retrieval.

With GetTagWait, process tags that have been requested are not accepted in the image. A

GetTagWait

retrieval reads the value explicitly from the AS. This always includes the send and

return path through the coupling and the response time of the AS. During this runtime, the

processing of the C actions is blocked and the time required for the retrieval cannot be

estimated. If multiple tags are read, the time is added.

A GetTagWait call is required if

● fast write/read procedures are to be synchronized

● a value is read explicitly from the AS

● or a registration is to be avoided in the image deliberately.

The GetTagWait call is to be avoided in cyclic C-Actions, this is the main reason for

performance problems.

ANSI-C function descriptions

3.3 Internal functions

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

1354

System Manual, 11/2008,

SetTag or SetTagWait?

The SetTag retrieval distributes a write job without waiting for confirmation from the AS.

The SetTagWait retrieval distributes a write job and waits for confirmation from the AS. This

always includes the send and return path through the coupling and the response time of the

AS. During this runtime, the processing of the C actions is blocked and the time required for

the retrieval cannot be estimated. If multiple tags are written, the time is added.

A SetTagWait call is set to guarantee that the value has been written before the C-Action is

processed any further. The SetTagWait call in cyclic C actions is to be avoided.

Note

The difference between GetTag and GetTagWait also exists for internal tags. The difference

not quite so serious here however, since no coupling comes into play. To synchronize fast

write/read procedures, the respective wait function is to be used with internal tags as well.

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.

3.3.5.2 get

Functionality of the GetTag functions

GetTagXXX

By calling the function the tag is logged on and, from that moment, polled cyclically from the

AS. The cycle for the registration depends on the trigger (see following description). For

GetTagXXX

calls, the value that is available in WinCC is sent. For Close Picture, the tag actions

are ended again.

The call is marked by the following:

● The value is read from the tag image by WinCC.

● The call is faster in comparison to GetTagXXXWait (except for the first call which generally

takes longer because the value from the PLC must be read out and logged on).

ANSI-C function descriptions

3.3 Internal functions

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

System Manual, 11/2008,

1355

● The duration of the call does not depend on the bus-load or on the AS.

● The function does not deliver any information on the status of the tags

Note

If a tag is requested in a Global Script action, it remains registered throughout the enter

Runtime of WinCC.

In Callback functions, the respective GetTagXXXWait function must be used.

Behavior in actions with tag trigger (recommended):

All of the tags contained in the tag trigger are already known with Open Picture and are

registered with the defined monitoring time.

Since all tags are requested at once, the best possible optimization can be targeted from the

channel. If a tag is requested with GetTagXXX() within a C-Action, which is contained in the

trigger, the value already exists and is sent directly to the call (high-performance).

Registering tags in actions with tag trigger

As the tags are already known when the picture is selected, they can be transmitted in a job

to the Data Manager and so be registered collectively to the channel.

Note

If a tag is requested, which is not in the trigger, then the behavior is the same as with the

default trigger.

ANSI-C function descriptions

3.3 Internal functions

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

1356

System Manual, 11/2008,

Behavior in actions with default trigger:

tags are registered with half of the cycle time with the first call. For every other call, the value

is present.

Registering tags in actions with default trigger and event trigger

Only when the individual actions are executed is it identified which tags are needed in the

picture. As a result, the tags are registered to the channel in a large number of single jobs.

When

a picture with cyclic actions is selected, the continual reorganization may place a heavy

strain on communications.

Example: The channel supports custom cycle creation. Usually cycles are created by the

channel directly from the AS. The resources for these cycles are limited by the AS. As a result,

the channel stops the current jobs for this cycle and reconfigures the cycle on the AS.

Behavior in event triggered actions:

The tag is registered in the "upon change" mode with the first call. Process tags that are

registered in the "upon change" mode correspond with a cyclic read job with a cycle time of

1s.

ANSI-C function descriptions

3.3 Internal functions

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

System Manual, 11/2008,

1357

Note

If a value is requested by GetTagXXX() by a mouse click for example, the tag is accepted in

the

tag image. The tag is requested cyclically from the AS as of this point in time and therefore

increases the basic load.

To avoid this increase in basic loading, the value can be requested by GetTagXXXWait().

The call GetTagXXXWait() causes a higher communication load one time but the tag is not

added to the tag image.

GetTagXXXWait

The function returns the current value. The tag is not registered cyclically, the value is

requested from the AS one time only.

The call is marked by the following:

● The value is read explicitly from the AS.

● The call, compared with GetTagXXX, takes longer.

● The duration of the call does not depend on the bus-load or on the AS.

● The function does not deliver any information on the status of the tags.

GetTagXXXState

The function GetTagXXXState has the same features as GetTagXXX, it also sends the function

information on the status of the tags. Since the status is always delivered internally, there is

no performance difference to GetTagXXX.

GetTagXXXStateWait

The function GetTagXXXStateWait has the same features as GetTagXXXWait, additionally it

sends the function information on the status of the tags. Since the status is always delivered

internally, there is no performance difference to GetTagXXXWait.

ANSI-C function descriptions

3.3 Internal functions

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

1358

System Manual, 11/2008,

The difference between functions GetTagXXXStateWait and GetTagXXXState corresponds

with the difference between GetTagXXXWait and GetTagXXX. Since the value is explicitly

read from the AS for process tags, the value and the status can be more current than for

GetTagXXXState.

GetTagXXXStateQC

The function GetTagXXXStateQC has the same features as GetTagXXXState. The function

also delivers information on the quality code of the tag.

GetTagXXXStateQCWait

The function GetTagXXXStateQCWait has the same features as GetTagXXXStateWait. The

function also delivers information on the quality code of the tag.

GetTagMultiWait

The function GetTagMultiWait has the same features as GetTagXXXWait. However, it allows

the

request for more tags in a job. Therefore, the read requests in the direction of the AS can

be optimized in most cases so that only one request will be given to the AS.

GetTagMultiStateWait

The function GetTagMultiStateWait has the same features as GetTagMultiWait, additionally it

sends the function information on the statuses of the tags.

GetTagMultiStateQCWait

The function GetTagMultiStateQCWait has the same features as GetTagMultiStateWait. The

function also delivers information on the quality codese of the tags.

state

wait

getTagBitStateWait

Function

Determines the value of a tag of data type "Binary tag". The value is read explicitly from the

AS. The status of the tag is also returned.

Syntax

BOOL GetTagBitStateWait(Tag Tag_Name, PDWORD lp_dwstate);

ANSI-C function descriptions

3.3 Internal functions

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

System Manual, 11/2008,

1359

Parameters

Tag_Name

name of the tag

lp_dwstate

Pointer to a DWORD in which the status of the tag is stored after the function has been

completed.

Return value

Value of the tag in the data type "BOOL"