AFPromptForCredential.ShowDialog Method (IWin32Window, PISystem, Boolean)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Show the prompt for credential dialog to get a NetworkCredential to
connect to a PISystem.
Namespace: OSIsoft.AF.UI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static NetworkCredential ShowDialog( IWin32Window owner, PISystem system, bool failMessage = false )
Public Shared Function ShowDialog ( owner As IWin32Window, system As PISystem, Optional failMessage As Boolean = false ) As NetworkCredential Dim owner As IWin32Window Dim system As PISystem Dim failMessage As Boolean Dim returnValue As NetworkCredential returnValue = AFPromptForCredential.ShowDialog(owner, system, failMessage)
public: static NetworkCredential^ ShowDialog( IWin32Window^ owner, PISystem^ system, bool failMessage = false )
static member ShowDialog : owner : IWin32Window * system : PISystem * ?failMessage : bool (* Defaults: let _failMessage = defaultArg failMessage false *) -> NetworkCredential
Parameters
- owner
- Type: System.Windows.FormsIWin32Window
The owner window for the dialog box. - system
- Type: OSIsoft.AFPISystem
The PISystem for the requested login credential. - failMessage (Optional)
- Type: SystemBoolean
If , the description in the dialog will indicate that a failed login attempt has occurred.
Return Value
Type: NetworkCredentialReturns if the dialog was canceled. Otherwise, a NetworkCredential is returned based upon the information provided in the dialog.
Remarks
This method is used to show a dialog to prompt for user credentials to be used when
connecting to a PISystem. If the RememberCredential property
is after the dialog is closed, then the credentials will be
saved to the Windows Credential Manager using the SaveCredential(String, String, SecureString) method.