TElPGPKeyring.ListKeys method

Discuss this help topic in SecureBlackbox Forum

TElPGPKeyring.ListKeys

TElPGPKeyring See also

Filter: C# VB.NET Pascal C++ PHP Java

This method selects keys from the keyring according to a template.

Declaration

[C#]
    void ListKeys(bool PublicOnly, string Template, ref ArrayList ListOfKeys);
    void ListKeys(bool PublicOnly, string Template, bool IncludeSubkeysMatchingUserIDTemplateInResult, ref ArrayList ListOfKeys);
    void ListKeys(bool PublicOnly, String[] Templates, bool IsAndCondition, ref ArrayList ListOfKeys);
    void ListKeys(bool PublicOnly, String[] Templates, bool IsAndCondition, bool IncludeSubkeysMatchingUserIDTemplateInResult, ref ArrayList ListOfKeys);

[VB.NET]
    Sub ListKeys(ByVal PublicOnly As Boolean, ByVal Template As String, ByRef ListOfKeys As ArrayList)
    Sub ListKeys(ByVal PublicOnly As Boolean, ByVal Template As String, ByVal IncludeSubkeysMatchingUserIDTemplateInResult As Boolean, ByRef ListOfKeys As ArrayList)
    Sub ListKeys(ByVal PublicOnly As Boolean, ByVal Templates As String[], ByVal IsAndCondition As Boolean, ByRef ListOfKeys As ArrayList)
    Sub ListKeys(ByVal PublicOnly As Boolean, ByVal Templates As String[], ByVal IsAndCondition As Boolean, ByVal IncludeSubkeysMatchingUserIDTemplateInResult As Boolean, ByRef ListOfKeys As ArrayList)

[Pascal]
    procedure ListKeys(PublicOnly : boolean; const Template : string; var ListOfKeys : TList);
    procedure ListKeys(PublicOnly : boolean; const Template : string; IncludeSubkeysMatchingUserIDTemplateInResult : boolean; var ListOfKeys : TList);
    procedure ListKeys(PublicOnly : boolean; const Templates : array of string; IsAndCondition : boolean; var ListOfKeys : TList);
    procedure ListKeys(PublicOnly : boolean; const Templates : array of string; IsAndCondition : boolean; IncludeSubkeysMatchingUserIDTemplateInResult : boolean; var ListOfKeys : TList);

[C++]
    void ListKeys(bool PublicOnly, const std::string &Template, TList &ListOfKeys);
    void ListKeys(bool PublicOnly, const std::string &Template, bool IncludeSubkeysMatchingUserIDTemplateInResult, TList &ListOfKeys);
    void ListKeys(bool PublicOnly, const TStringList &Templates, bool IsAndCondition, TList &ListOfKeys);
    void ListKeys(bool PublicOnly, const TStringList &Templates, bool IsAndCondition, bool IncludeSubkeysMatchingUserIDTemplateInResult, TList &ListOfKeys);

[PHP]
    void ListKeys(bool $PublicOnly, string $Template, TList &$ListOfKeys)
    void ListKeys(bool $PublicOnly, string $Template, bool $IncludeSubkeysMatchingUserIDTemplateInResult, TList &$ListOfKeys)
    void ListKeys(bool $PublicOnly, TStringList $Templates, bool $IsAndCondition, TList &$ListOfKeys)
    void ListKeys(bool $PublicOnly, TStringList $Templates, bool $IsAndCondition, bool $IncludeSubkeysMatchingUserIDTemplateInResult, TList &$ListOfKeys)

[Java]
    void listKeys(boolean PublicOnly, String[] Templates, boolean IsAndCondition, ArrayList ListOfKeys);
    void listKeys(boolean PublicOnly, String Template, boolean IncludeSubkeysMatchingUserIDTemplateInResult, ArrayList ListOfKeys);
    void listKeys(boolean PublicOnly, String[] Templates, boolean IsAndCondition, boolean IncludeSubkeysMatchingUserIDTemplateInResult, ArrayList ListOfKeys);
    void listKeys(boolean PublicOnly, String Template, ArrayList ListOfKeys);

Parameters

IncludeSubkeysMatchingUserIDTemplateInResult - …
IsAndCondition - specifies whether to use logical AND condition for many templates
ListOfKeys - list of the selected keys
PublicOnly - set this parameter to True to select public keys only
Template - template of the key
Templates - templates of the keys

Description

Use this method to get the list of keys from the keyring by the template. The template(s) should be of the form "Name=Value". Supported names are: userid, fp, fingerprint, keyid.

See also: …

Discuss this help topic in SecureBlackbox Forum