Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFPromptForCredential Constructor

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFPromptForCredential Constructor
Creates a new instance of the dialog used to prompt for a user name and password.

Namespace:  OSIsoft.AF.UI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public AFPromptForCredential(
	string title,
	string description = null,
	bool enableRememberCredentials = false,
	bool enableAuthenticationMode = false
)
Public Sub New ( 
	title As String,
	Optional description As String = Nothing,
	Optional enableRememberCredentials As Boolean = false,
	Optional enableAuthenticationMode As Boolean = false
)

Dim title As String
Dim description As String
Dim enableRememberCredentials As Boolean
Dim enableAuthenticationMode As Boolean

Dim instance As New AFPromptForCredential(title, description, 
	enableRememberCredentials, enableAuthenticationMode)
public:
AFPromptForCredential(
	String^ title, 
	String^ description = nullptr, 
	bool enableRememberCredentials = false, 
	bool enableAuthenticationMode = false
)
new : 
        title : string * 
        ?description : string * 
        ?enableRememberCredentials : bool * 
        ?enableAuthenticationMode : bool 
(* Defaults:
        let _description = defaultArg description null
        let _enableRememberCredentials = defaultArg enableRememberCredentials false
        let _enableAuthenticationMode = defaultArg enableAuthenticationMode false
*)
-> AFPromptForCredential

Parameters

title
Type: SystemString
The dialog box title.
description (Optional)
Type: SystemString
The description displayed on the dialog box.
enableRememberCredentials (Optional)
Type: SystemBoolean
If , then the remember credentials check box is displayed on the dialog. The default value is .
enableAuthenticationMode (Optional)
Type: SystemBoolean
If , then the authentication mode combo box is displayed on the dialog. The default value is .

Remarks

This creates a new instance of the dialog used to prompt for a user name and password. It is used by the ShowDialog Overload methods to prompt for a credential to be used to connect to a server.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in