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

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

5. Computer

6. Current time in format "yyyy.mm.dd, hh:mm:ss.mmm"

Note

The value "Instance" of string "MSG_RTDATA_STRUCT" is only supplied if an instance

message was triggered.

The values "User" and "Computer" of the string "MSG_RTDATA_STRUCT" are only

supplied if a comment was provided during the creation of the message with the same

call.

Return value

TRUE

The function has been completed without any errors.

FALSE

An error has occurred.

Note

Please note that modified standard functions are overwritten by a WinCC installation so that

the changes will be lost.

See also

Structure definition MSG_RTDATA_STRUCT (Page 1556)

3.2.3 Graphics

3.2.3.1 Graphics - short description

The Graphics group contains functions for programming the graphic system.

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.

ANSI-C function descriptions

3.2 Standard functions

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

System Manual, 11/2008,

841

3.2.3.2 GetLinkedVariable

Function

Provides the name of the variable linked to a certain object property.

Syntax

char* GetLinkedVariable(char* lpszPictureName, char* lpszObjectName, char*

lpszPropertyName);

Parameters

lpszPictureName

Pointer to the picture

lpszObjectName

Pointer to the object

lpszPropertyName

Pointer to the object property

Return value

Pointer to the name of the tag linked to a certain object property.

See also

GetLinkedVariable example (Page 1483)

3.2.3.3 GetLocalPicture

Function

Provides a pointer to the name of the picture. The picture name is the file name without the

".PDL" extension.

Syntax

char* GetLocalPicture(char* lpszPictureName);

ANSI-C function descriptions

3.2 Standard functions

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

842

System Manual, 11/2008,

Parameters

lpszPictureName

Pointer to the picture

Return value

Pointer on the name of the picture.

Note

The passed call parameter lpszPictureName must have the structure provided by the

graphics system for the picture paths:

<Basic picture name>.<Picture window name>:<Picture name>. ... .<Picture window

name>[:<Picture name>]

where <Basic picture name> and <Picture name> go without the ".PDL" file extension.

Example:

In a basic picture "AAA" there is a picture window "bbb" in which a picture "CCC" is called

which itself contains a picture window "ddd" in which a picture "EEE" is called.

Then the function call

GetLocalPicture(lpszPictureName)

returns the pointer to the picture name:

"EEE" if the functions is called in the picture "EEE";

"CCC" if the functions is called in the picture "CCC";

"AAA" if the functions is called in the picture "AAA".

See also

GetLocalPicture example (Page 1483)

3.2.3.4 GetParentPicture

Function

Provides a pointer to the name of the picture. The picture name is the file name without the

".PDL" extension.

ANSI-C function descriptions

3.2 Standard functions

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

System Manual, 11/2008,

843

Syntax

char* GetParentPicture(char* lpszPictureName);

Parameters

lpszPictureName

Pointer to the picture

Return value

Name of the current picture if the function is called in the basic picture

Name path of the higher-level picture if the function is called in a picture window

Note

The passed call parameter lpszPictureName must have the structure provided by the

graphics system for the picture paths:

<Basic picture name>.<Picture window name>:<Picture name>. ... .<Picture window

name>[:<Picture name>]

where <Basic picture name> and <Picture name> go without the ".PDL" file extension.

See also

GetParentPicture example (Page 1485)

3.2.3.5 GetParentPictureWindow

Function

Provides a pointer to the name of the picture window.

Syntax

char* GetParentPictureWindow(char* lpszPictureName);

Parameters

lpszPictureName

Pointer to the picture

ANSI-C function descriptions

3.2 Standard functions

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

844

System Manual, 11/2008,

Return value

Pointer to the name of the picture window if the function is called in a picture displayed in a

picture window of a higher-level picture

Call parameter lpszPictureName unchanged if the function is called in the basic picture

Note

The passed call parameter lpszPictureName must have the structure provided by the

graphics system for the picture paths:

<Basic picture name>.<Picture window name>:<Picture name>. ... .<Picture window

name>[:<Picture name>]

where <Basic picture name> and <Picture name> go without the ".PDL" file extension.

Example:

In a basic picture "Picture_1" there is a picture window "Picture_window_1" in which a picture

"Picture_2" is called.

In the picture "Picture_2" there is a picture window "Picture_window_2" in which a picture

"Picture_3" is called.

Then the function call

GetParentPictureWindow(lpszPictureName)

returns the pointer to the picture window name:

"Picture_2" if the function is called in the picture "Picture_3";

"Picture_window_1" if the function is called in the picture "Picture_2";

"Picture_1" if the function is called in the picture "Picture_1".

3.2.3.6 OpenPicture

Function

Changes the specified basic picture. On the client and in case of a picture name with server

prefix a picture change is performed in the picture window.

Syntax

void OpenPicture(Picture PictureName)

ANSI-C function descriptions

3.2 Standard functions

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

System Manual, 11/2008,

845

Parameters

Picture name

3.2.3.7 Registry2

Function

This function manages a list of string pairs (String0, String1).

It knows the following types of calls controlled by the mode parameter:

● Registry2("set", "String0", "String1");

Includes the passed string pair into the list.

● Registry2("get", "String0", NULL);

Returns the first string pair partner String1 which belongs to the passed String0 and then

deletes the string pair from the list.

● Registry2("reset", NULL, NULL);

Deletes all string pairs from the list.

● Registry2("display", NULL, NULL);

Shows the string pairs currently stored in the list in a Global Script diagnostics window.

Syntax

char* Registry2(char* mode, char* String0, char* String1);

Parameters

mode

Defines the working principle of the function.

set Incorporation of the string pair into the list

get Determination of the first sting pair partner for String0 and deletion of the string

pair from the list

reset Deletion of all string pairs

display Display of the string pairs in a Global Script diagnostics window

String0

The parameter supply depends on the working principle of the function.

ANSI-C function descriptions

3.2 Standard functions

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

846

System Manual, 11/2008,

String1

The parameter supply depends on the working principle of the function.

Return value

In the mode=get mode a pointer to the first string pair partner is returned.

Note

This function is used in conjunction with the picture module technology.

If you work with the "Create faceplate as type" and "Create instance(s) in the process picture"

wizards in the "Faceplates" tab of the Dynamic Wizard, using the "Registry2" function is not

permitted!

3.2.4 Report

3.2.4.1 Report - short description

The Report group contains functions with which to start the print preview of a print job or the

printout itself.

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.2.4.2 RPTJobPreview

Function

The preview of a print job is started.

Syntax

BOOL RPTJobPreview(LPSTR lpJobName)

ANSI-C function descriptions

3.2 Standard functions

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

System Manual, 11/2008,

847

Parameters

lpJobName

Pointer to the name of the print job

Return value

TRUE

The function has been completed without any errors.

FALSE

An error has occurred.

See also

RPTJobPreview example (Page 1511)

3.2.4.3 RPTJobPrint

Function

A print job is started.

Syntax

BOOL RPTJobPrint(LPSTR lpJobName)

Parameters

lpJobName

Pointer to the name of the print job

Return value

TRUE

The function has been completed without any errors.

ANSI-C function descriptions

3.2 Standard functions

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

848

System Manual, 11/2008,

FALSE

An error has occurred.

See also

RPTJobPrint example (Page 1511)

3.2.4.4 RptShowError

Function

This function provides an error decription for a failed print job.

The function is already integrated into the RptJobPrint and RptJobPreview standard functions

and does not have to be called separately.

The error description is displayed in a Global Script diagnostics window.

Note

As RptShowError is a standard function the output type and form can be changed if required.

Please note that modified standard functions are overwritten by a WinCC installation so that

the changes will be lost.

Syntax

void RptShowError ( LPCSTR pszFailedFunction, CMN_ERRORA* pCmnErrorA )

Parameters

pszFailedFunction

Pointer to the name of the failed function.

If this pointer is NULL there will be no output of the function name.

pCmnErrorA

Pointer to the error structure of the failed function.

If this pointer is NULL there will be no output of the error structure.

STRUCTURES_TABLES_ERROR_STRUCTURE

ANSI-C function descriptions

3.2 Standard functions

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

System Manual, 11/2008,

849

3.2.5 WinCC

3.2.5.1 WinCC - short description

The WinCC group contains functions which affect the entire WinCC system.

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.2.5.2 GetHWDiag

Function

This function realizes the direct start of diagnosis at runtime triggered by an event, which must

be configured, exercised on an object.

If the event occurs, the hardware diagnostics function is started from STEP7 for the associated

PLC.

The following conditions must be fulfilled in order to use the function:

● The WinCC project, with the picture from which access should occur, and the STEP7 project

must be on the same computer.

● The WinCC project must be stored as a subdirectory of the STEP7 project (STEP7 Projekt

\wincproj\WinCC Projekt).

● The S7 tags have been mapped to WinCC.

Syntax

BOOL GetHWDiag(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR

lpProperties)

Parameters

lpszPictureName

Name of the picture (PDL file) that contains the tag that will be used for the entry point for the

hardware diagnostics

Since the name "lpszPictureName" stands for the current picture, entries are only required

here in cases where it is necessary to access an object tag in a different picture.

ANSI-C function descriptions

3.2 Standard functions

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

850

System Manual, 11/2008,