Programming with Reflection

image\rwnprg32.gif WaitForPasswordExceptions method

 

Syntax Found = object.WaitForPasswordExceptions(SuccessString, HostUserName, HostType, [Timeout], [HostName], [Options])

 

Description

If a Password Exceptions macro has been specified (using PasswordMacroFileName), this method runs that macro. The Password Exeptions macro handles incorrect and expired passwords.

If no Password Exceptions macro is present, this method waits for the specified SuccessString to be received from the host. In this case the values for HostUserName, HostType, and HostName are ignored.

Arguments

SuccessString Argument type: String
Required
The string that indicates the host has accepted the password.

HostUserName Argument type: String
Required
Specifies a host user name. This value is used by the GetPassword method in the Password Exceptions macro.

HostType Argument type: String
Required
Specifies the host type. This value is used by the GetHostElement and GetPassword method in the Password Exceptions macro.

Timeout Argument type: String
Optional
Specifies the amount of time to wait for the string to be received. The string is specified in HH:MM:SS.hh format. If this argument is omitted or is empty (""), Reflection waits forever if the string is not received.

HostName Argument type: String
Optional
Specifies a host name. This value is used by the GetHostElement method in the Password Exceptions macro.

Options Argument type: Enumeration
Optional
Specifies additional, non-default behavior for the method. You can combine two or more options using addition as shown here:

      rcAllowKeystrokes + rcNoDisplay

 rcAllowKeystrokes

 Specifies that the user is allowed to enter keystrokes in the terminal window during the wait.

 rcNoDisplay

 Specifies that incoming datacomm characters should not be displayed in the terminal window during the wait.

 rcNoTranslation

 Specifies that the string contains binary data. Binary data is matched exactly as it is received from the host without any host-to-PC character translation.

 rcHexData

 Indicates that portions of a string that follow a backslash should be interpreted using either hexadecimal code or C-language character conventions. For example, the following statement waits for the fraction symbol ¼ (specified using the decimal code x0BC) followed by a carriage return (specified using the \r special character):

Return

Found Return type: Boolean
True if the Password Exception macro returns succsess. If no Password Exeption macro is present, this True means that the specified SuccessString was received from the host. False if the method timed out. If no Timeout is specified, this method cannot return False.

 

image\jump.gif Keyword Index

image\popup.gif Related Topics

image\popup.gif Reflection products that use this command