GetAvailableAuthenticationOptions Method (IPISDKOptions interface)

                    

 

This method returns a NamedValues collection of Authentication options supported by the PISDK on the client. The contained NamedValue objects represent the options where the Name property is the option name.  The Value property contains an integer index number. This integer is the same index found the the Value field for the corresponding option item in the PIConstants AuthenticationOptionsConstants and DispAuthenticationOptionsConstants.

Syntax

object.GetAvailableAuthenticationOptions

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

Remarks

The list of options depends on the client machine's configuration. Because some of the possible AuthenticationOptions may not be supported in a given environment, an application should use this method to verify which options are available. Use the GetAuthenticationOptions method to get the current active setting and SetAuthenticationOptions to modify the current setting.

Some of the supported authentication options 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