VBAction Statement

The VBAction statement specifies interface information for an action. This information includes the action name, action description, return type, and the C++ member function that implements the action. To describe the implementation as well as the interface of a promoted action, use the VBPromotedAction statement. To describe member functions that support attributes, use the VBAttribute statement.

{ //VBAction: name, description?, vbReturnType?, signature, featureFlag* }

name
Action name to be used in visual composition.

description
Optional feature description.

( "text description" | (resourceId, resourceDll) )

resourceId
Optional resource number of the descriptive text. If you specify a resource ID, you must also specify the resource DLL name.

resourceDll
Optional resource DLL name containing the descriptive text. You must specify the DLL name if you specify a resource ID. Do not include the .dll extension.

vbReturnType
Optional return type that specifies the type of the return value from the action and allows the user to make connections to this value. Connections are available through the actionResult event. The return type must be compatible with the return type in the action member function signature.

signature
For a visual, nonvisual, or class interface part, the signature of the C++ public member function that implements the action. For a function group part, the signature of the C function that implements the action. The parameter names are used in the Composition Editor to name parameter connections.

featureFlag
Optional feature flag.

( connect | noconnect | preferred | noWin | noOS2 | noAIX )

connect
Allows connections to the action. If neither connect nor noconnect is specified, connect is assumed.

noconnect
Prevents connections to the action.

preferred
Specifies that the feature is preferred for the part. Preferred features appear in the part connection list.

noWin
Excludes the feature on Windows.

noOS2
Excludes the feature on OS/2.

noAIX
Excludes the feature on AIX.


Related procedures
Defining the Part Interface Using Part Information Statements

Related references
Visual Part Information Statements
Nonvisual Part Information Statements
Class Interface Part Information Statements
Function Group Part Information Statements
Part Information Statement Descriptions
Part Information Statement Examples