AutomationParameter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Windows management functions

Miscellaneous WINDEV functions

AutomationParameter

Presentation

Example

Start subscript of the arrays sent to the ActiveX or automation objects

Passing the Automation arrays by value

BuildAutomationVariant

Calling a DLL written in Visual Basic

Constants for managing the WLanguage types

Constants for sound management

Constants used by ExecutePresetAction

Constants used by the TraceStart function

EndAutomatedProcedure

InAndroidEmulatorMode

InAndroidMode

InAndroidSimulatorMode

InAppleWatchEmulatorMode

InAppleWatchMode

InAppleWatchSimulatorMode

InAutomaticTestMode

InBackgroundMode

InComponentMode

InDelayedProcedureMode

InPocketSimulatorMode

InPrelaunchedSessionMode

InReportsAndQueriesMode

InServiceMode

InSimulatorMode

InStoredProcedureMode

InSysNotificationMode

InTSEMode

InTestMode

InUMCMode

InUniversalWindowsAppMode

InUniversalWindowsAppSimulatorMode

InUniversalWindowsPlatformMode

InUniversalWindowsPlatformSimulatorMode

InVGAMode

InWebMode

InWebSocketServerGlobalServiceMode

InWebSocketServerMode

InWindowsPhoneEmulatorMode

InWindowsPhoneMode

InWindowsPhoneSimulatorMode

InWindowsStoreAppMode

InWindowsStoreAppSimulatorMode

OpenDocumentAsynchronous

StyleDrawCaptionGrayed

Voice commands in your applications

WHelp

WINDEVVersion

WLanguage procedure called by OpenDocumentAsynchronous

diffApply

diffCreate

Start subscript of the arrays sent to the ActiveX or automation objects
Passing the Automation arrays by value

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

AutomationParameter (Function)

In french: AutomationParamètre

Configures the management of accesses to the ActiveX objects and to the Automation objects.

Example

// Defines the start subscript for the Automation arrays
AutomationParameter(apArrayBaseSubscript, 1)

Syntax

<Result> = AutomationParameter(<Parameter to process> [, <New value>])

<Result>: Type of the requested parameter

Current value of the parameter. If <New value> is specified, returns the value before modification.

<Parameter to process>: Integer constant

This parameter can correspond to:
Versions 15 and later
apBinaryString
New in version 15
apBinaryString
apBinaryString Retrieves the binary strings of OLE automation.
Possible values for <New value>: True or False
If the value is set to False (by default), the retrieval stops with the first binary 0.
apArrayBaseSubscript Specifies the source subscript for the arrays sent to the ActiveX or Automation objects.
Possible values for <New value>: 0 or 1
apArrayByValue Forces the arrays sent to ActiveX or Automation objects to be passed by value.
Possible values for <New value>: True or False.

<New value>: Optional parameter, type of the parameter to modify

Value that must be given to the parameter.

Remarks

Start subscript of the arrays sent to the ActiveX or automation objects

When using the WLanguage arrays with ActiveX or automation objects, the WLanguage generates Automation arrays whose subscripts start from 0.

Some ActiveX objects or Automation objects require arrays whose subscripts start from 1.

To define the start subscript of the Automation arrays, all you have to do is use the following code line:

AutomationParameter(apArrayBaseSubscript, 1)

Passing the Automation arrays by value

WINDEV passes the WLanguage arrays by reference to the ActiveX or automation objects.

Some ActiveX or Automation objects do not support the passage of arrays by reference.

To force the arrays to be passed by value, the array must be enclosed in brackets during each call:

AutomationObject>>Method(5,(MyWLArray))

Instead of:

AutomationObject>>Method(5, MyWLArray)

To force all the arrays to be passed by value, all you have to do is use the following code line:

AutomationParameter(apArrayByValue, True)

Component: wd270ole.dll