COM Operations Details (Magic xpi 3.x)
When you define a COM service in the Service Repository, you should click the Operations button to open the Operations dialog box. Here, you can define the service's operations and their parameters. Click New on the left side of the dialog box to add a new operation.
The Operations dialog box consists of three sections. The left section is the Operation Name pane, which contains a list of operations. You can add or delete operations by clicking the New or Delete buttons.
The upper section of the dialog box is the Return Parameter Details pane. This contains the following fields:
|
|
|
|
Return Parameter Details
|
|
Type
|
Select one of the following parameter types from the drop-down list:
-
Alpha
-
Numeric
-
Date
-
Time
-
Logical
|
|
Picture
|
Define the returned parameter's format by entering a string of characters. For example, a 15-character alpha-numeric parameter has a picture definition of 15. A picture that defines a date is MM/DD/YY.
|
|
COM Type
|
Select a return COM type from the drop-down list:
-
VT_BOOL
-
VT_BSTR
-
VT_DATE (Date)
-
VT_DATE (Time)
-
VT_I4
-
VT_R8
|
Note:
|
The COM types available depend on the parameter type that you select in the Type field (above).
|
|
|
|
Argument Details (Click New to add arguments to the operation)
|
|
Argument Name
|
Enter the argument name. The first argument, by default, is IBPrincipal, which cannot be modified. This argument contains the user name that is used to authenticate the flow, and is essentially a security feature.
|
|
Data Type
|
Select one of the following argument types from the drop-down list:
-
Alpha
-
Numeric
-
Date
-
Time
-
Logical
-
BLOB
|
|
Picture
|
Define the argument's format by entering a string of characters. For example, a 15-character alpha-numeric parameter has a picture definition of 15. A picture that defines a date is MM/DD/YY.
|
|
Direction
|
Select one of the following directions from the drop-down list:
|
|
COM Type
|
Enter a COM type.
|
You can click the Help Files button to open the Help Files dialog box. Here, you can enter the following properties:
|
|
|
|
Version
|
Defines the help file version.
|
|
Library Help File
|
Defines the help file for the library.
|
|
Library Help Key
|
Defines the help key in the help file that provides a description of the library.
|
|
Library Help String
|
Defines the help string that provides initial information about the library.
|
|
Object Help File
|
Defines the help file for the object.
|
|
Object Help Key
|
Defines the help key in the help file that provides a description of the object.
|
