Как правильно вызвать функцию PDLCSGetAction в ODK?

BOOL PDLCSGetAction (

        LPCTSTR             lpszProjectName,

        LPCTSTR             lpszPictureName,

        LPCTSTR             lpszObjectName,

        LPCTSTR             lpszPropertyName,

        LPDWORD             pdwBlobLen,

        LPVOID*             ppvAction,

        LPDWORD             pdwFlags,

        enum TriggerType    Trigger,

        LPVOID              (*pfnAlloc)( size_t ),

        PCMN_ERROR          pError );

Description

This function inquires the P code of a C action linked to an object property.

Parameters

lpszProjectName

Pointer to the name of the project including path and name extension.

lpszPictureName

Pointer to the name of the picture, without the path, but including the name extension. Sensitive to upper and lower case letters.

lpszObjectName

Pointer to the name of the object

lpszPropertyName

Pointer to the name of the object property.

In order to read the C action of an event, this pointer must be NULL.

pdwBlobLen

Pointer to a tag returning the length of the code in bytes.

ppvAction

Address of a pointer returning the address of the C action code. The buffer for the code is allocated by the function.

The pointer can be used as parameter after casting on LPACTION in the script programming routines.

pdwFlags

Pointer to a tag which returns the flags identifying the type of the code provided:

AP_AKT_OBJ_PCODE
 compiled P code.
 
AP_AKT_OBJ_NO_PCODE
 source code.
 

Trigger

Type of the trigger definition within the object. The enumTriggerType is defined in the "trigger.h" file.

NotDefined
 (must be set in order to read out the dynamic dialog of a property)
 
MouseClick
 
 
MouseLButtonDown
 
 
MouseLButtonUp
 
 
MouseRButtonDown
 
 
MouseRButtonUp
 
 
KeyboardDown
 
 
KeyboardUp
 
 
ObjectChange
 
 
PropertyChange
 
 
PropertyStateChange
 
 
PictureOpen
 
 
PictureClose
 
 
ObjectDefined
 
 
FocusEnter
 
 
LastTriggerType
 
 
ObjSpecificTriggerStart
 = 0x1000
 

In order to access internal user object events by means of the TriggerID (possible with WinCC Version V5.0 or higher) it is required to add to the ObjSpecificTriggerStart constant the object index (1 - n) of the corresponding sequence, like in the PropertySheet under the "Object events" entry.

pfnAlloc

Pointer to a function of the calling application in order to allocate memory for the code of the C action.

pError

Pointer to the data of the extended error message within the CMN_ERROR structure. In the event of an error, the system writes error information to this structure.

Return Value

TRUE

P code has been determined.

FALSE

Error

Comments

The memory allocated must be cleared by the calling application.

The table below shows how to procede when assigning values to the szPropertyName and Trigger parameters in order to set a specific action type.

szPropertyName
 Trigger
 Action type
 
<> NULL
 "NotDefined"
 Assignment action
 
= NULL
 "MouseClick"
"MouseLButtonDown"
"MouseLButtonUp"
"MouseRButtonDown"
"MouseRButtonUp"
""KeyboardDown"
"KeyboardUp"
 Action on the object
 
= NULL
<> NULL
<> NULL
 "ObjectChange"
"PropertyChange"
"PropertyStateChange"
 Property/status change
 

With the exception of the default triggers, such as a mouseclick or keyboard event, a call with szPropertyName not equal to NULL and trigger = "PropertyChange" also works with OCX objects.