KeyList Event

Fires for each key in the keyring when ListKeys is called.

Syntax

[VB.NET]
Public Event OnKeyList As OnKeyListHandler

[C#]
public event OnKeyListHandler OnKeyList;

public delegate void OnKeyListHandler(object sender, KeymgrKeyListEventArgs e);

class KeymgrKeyListEventArgs : EventArgs {
  string UserId {get;}
  string KeyId {get;}
  string Fingerprint {get;}
  bool HasSecretKey {get;}
  string PublicKeyAlgorithm {get;}
  int PublicKeyLength {get;}
}

Remarks

This event fires once for each key in the Keyring when ListKeys is called.

UserId holds the current user Id of the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Not all values are required when selecting or generating a key, but at least FirstName or Email are required.

KeyId is the hex-encoded, 4- or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the Fingerprint. For instance:

BF52A0AB

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

HasSecretKey returns True if the key contains a secret key.

PublicKeyAlgorithm is the public key algorithm. Possible values are "RSA" and "DSA".

PublicKeyLength is the length of the public key. Common values are 512, 1024, and 2048.