GetAuthenticationOptions Method (IPISDKOptions interface)

                    

 

This method returns a NamedValues collection containing the ordered set of Authentication options currently in effect in the running application.  Each contained NamedValue object represents a means of Authentication where the Name property is the option name. The returned collection does not have the "sorted" behavior turned on so can be iterated for an in-order presentation of the options.  In addition, the  Value property of each option contains the one-based order number. During connection attempt, PISDK tries each of the Authentication option in the same order.

Syntax

object.GetAuthenticationOptions

The object placeholder is an object expression that evaluates to an IPISDKOptions interface, obtained from a PISDK object.

Remarks

The Authentication options returned in this method are drawn from the list of options returned by the GetAvailableAuthenticationOption method.

Some of the possible authentication options currently supported are:

Setting Description
SSPI Windows Security Support Provider Interface (Single Sign On)
Trust PI Server trust mechanism
DefaultUser Default PI user name with a blank password

 

Trappable Errors

In addition to generic errors (such as Out of Memory), the following errors may occur:

Error

Description

E_INVALIDARG, E_POINTER Some of the function arguments are not valid.
pseNAMEDVALUESCREATE Fail to create NameValues collection.
Enabling Operational Intelligence