Location: Symbol Reference > Types > TJwOnElevationGetCredentials Type
Collapse All
JWSCL Documentation
ContentsIndexHome
PreviousUpNext
TJwOnElevationGetCredentials Type
JwsclTypes  Types  Example  See Also  Send Feedback
Pascal
TJwOnElevationGetCredentials = procedure ( var Abort : Boolean; var UserName, Password : TJwString; var EncryptedPassword : Boolean; var Entropy : PDataBlob; var EncryptionPrompt : Boolean; var Environment : Pointer; var lpStartupInfo: TStartupInfoW) of object;
File
Parameters
Parameters 
Description 
Abort 
Set abort to true if you like to abort the elevation process. A EJwsclAbortException will be thrown though. 
UserName 
Receives a username that has administrative privileges. By default it contains "Administrator.". However the JwElevateProcess Function does not check whether the user is really an administrator or even exists. It just tries to create the process and will fail if the user does not exist. The new process mayb not have administrator powers. 
Password 
This parameter receives a plaintext or encrypted password depending on parameter EncryptedPassword. 
EncryptedPassword 
Defines whether parameter Password is encrypted (true) or plaintext (false). 
Entropy 
Receives additional data that was used for the encryption and must be supplied to decrypt the password. 
EncryptionPrompt 
This parameter defines whether a decryption prompt is shown (true) to confirm the decryption by the user. Set to false to suppress the dialog (default). 
Environment 
This parameter receives the user environment block created by WinAPI CreateEnvironmentBlock. The data is freed automatically if Abort is false. 
lpStartupInfo 
This parameter receives a StartupInfo structure that contains more information for CreateProcess. The cb member (size) is ignored.
 
Description

The TJwOnElevationGetCredentials event is called by the JwElevateProcess Function if

  • SuRun is not available
  • UAC is not supported by OS
  • epfNoUi is set in parameter ElevationProcessFlags so no dialog box is shown.
 

It receives user credential to be used by CreateProcess.

Remarks

Any exception thrown in this function is returned by the JwElevateProcess Function. 

The exception EjwsclCryptApiException will be raised if the encrypted password could not be decrypted.

See Also
Example

This examples shows how to encrypt a password for OnElevationGetCredentials: 

 

Copy Code
procedure TForm1.OnElevationGetCredentials(var Abort: Boolean;
 var UserName, Password: TJwString; var EncryptedPassword: Boolean;
 var Entropy: PDataBlob; var EncryptionPrompt: Boolean;
 var Environment: Pointer; var lpStartupInfo: TStartupInfoW);
begin
 //set default username
 YourCredentialPrompt.UserName := UserName;

 //run login dialog
 Abort := not YourCredentialPrompt.Execute;
 if Abort then
 exit;

 UserName := YourCredentialPrompt.UserName;

 //secure password in memory -
 //no prompt and on local machine only
 Password := JwEncryptString(YourCredentialPrompt.Password, '', false,true);

 //the password is encrypted
 EncryptedPassword := True;
end;
Group
Links
Copyright (c) 2010. All rights reserved.
This help was created by Doc-O-Matic sponsored by toolsfactory software inc.
Contents | Index | Home
What do you think about this topic? Send feedback!