GetParams Method

Description

This method is provided as a shortcut to getting commonly used scan parameters all at once.

Syntax

Visual Basic
Public Function GetParams( _ ByRef Method As Long, _ ByRef Filter As Long, _ ByRef OperationMode As Long, _ ByRef HitType As Long, _ ByRef NominalMode As Long, _ ByRef BoundaryCondition As Long _ ) As Boolean

Visual Basic

Public Function GetParams( _
   ByRef Method As Long, _
   ByRef Filter As Long, _
   ByRef OperationMode As Long, _
   ByRef HitType As Long, _
   ByRef NominalMode As Long, _
   ByRef BoundaryCondition As Long _
) As Boolean

Parameters

Method: Required Long variable that gets the Method property.
Filter: Required Long variable that gets the Filter property.
OperationMode: Required Long variable that gets the OperationMode property.
HitType: Required Long variable that gets the HitType property.
NominalMode: Required Long variable that gets the NominalMode property.
BoundaryCondition: Required Long variable that gets the BoundaryCondition property.

Return Type

Boolean value. Boolean returns true if the function succeeds, false if it fails.

Remarks

If scan is a BasicScanCommand object, and M, F, O, H, N,and B are all Dimensioned as Object, the following are equivalent:

scan.GetParams M, F, O, H, N, B

M = scan.Method
F = scan.Filter
O = scan.OperationMode
H = scan.HitType
N = scan.NominalMode
B = scan.BoundaryCondition