GetSecurity

Returns information about the security drivers that make up the current security context.

GetSecurity(DriverNumber, Properties, RuntimeInfo)

Parameters

Parameter Type Direction Description
DriverNumber numeric IN Security driver number, which identifies the driver about which information is required. Drivers are placed in the security context in the order that the SetSecurity operation was called. The first driver is driver number 1, the second is driver is number 2, and so on.
DriverProperties string INOUT Input value must be "SMTP=" or "POP=" to specify the security context for which information is being requested.

Output value returned is the DriverProperties string supplied in the SetSecurity operation. Maximum size is 255 bytes.

RuntimeInfo string OUT Uniface list containing runtime information provided by Uniface, and optionally by the security driver.

Uniface provides the named item: INUSE =TRUE|FALSE

  • TRUE—this driver has been used to establish its part of the security context.
  • FALSE—there is currently no connection, or, if the driver was optional, and has been omitted. Maximum size is 1023 bytes.

For information on specific driver parameters, consult the security driver documentation.

Return Values

Value Returned by $status
Value Meaning
0 Success
-1 Invalid driver number, no such driver
-2 Invalid driver properties keyword
-6 Memory allocation error

Use

GetSecurity can be called at any time.

Description

Security drivers that have negotiated options with the mail server should provide information about those options. The options returned are for the current connection or for the last one that was used.

For SMTP, this enables you to retrieve the negotiated options for a SendMail that implicitly opened and closed the connection.

For examples of how GetSecurity can be used, see Using Email Security Drivers.

Related Topics