TIdFinger

Hierarchy, Properties, Methods, Events, See Also, Unit: IdFinger

Implements a Finger protocol client.

TIdFinger = class(TIdTCPClient)

Unit

IdFinger

Description

The TIdFinger implements the Finger User Information Protocol or Finger (RFC 1288) as a client. The finger protocol is an interface for a database of information about users on a remote system and could include information such as if they were logged in to the system, when they last read their E-Mail or sometimes information the user wishes to make available publicly (.plan file).

TIdFinger.CompleteQuery

TIdFinger, See Also

Identifies a complete query for the protocol.

property CompleteQuery: String;

Description

CompleteQuery is the complete Finger query such as "user@host". The CompleteQuery property is provided as a convenience for programs which prompt for a query in this form. CompleteQuery may contain values that permit recursive finger queries on servers that permit this capability, such as:

      test@test.com@example.com

CompleteQuery consists of the values in the Query and Host properties.

TIdFinger.Query

TIdFinger, See Also

Specifies the query for the Finger method.

property Query: String;

Description

Query is a String property that represents the text for the query sent to the server when using the Finger method. Values in Query consist of components in one of the following forms:

username@host
username@host1@host2

For the second form of Query, there is no arbitrary limit to the number of @host tokens in the query.

Use CompleteQuery to get the query string that includes the value in Host.

TIdFinger.VerboseOutput

TIdFinger, See Also

Instructs the server to provide detailed output.

property VerboseOutput: Boolean;

Description

VerboseOutput indicates to the server that it should give more detailed information than with a regular finger query. However, this will probably not work on many systems so it is set to False by default.

VerboseOutput is used in the Finger method, and indicates that additional arguments should be appended to the Query property prior to connection and transmission to the server.

TIdFinger.Create

TIdFinger, See Also

Instantiates a TIdFinger instance.

constructor Create(AOwner: TComponent); override;

Parameters

AOwner: TComponent

Owner of the object instance.

Description

Create constructs a properly initialized instance of TIdFinger using the inherited Create constructor, and initializes Port to the constant value IdPORT_FINGER (Decimal 79) as required by the Finger Protocol.

TIdFinger.Finger

TIdFinger, See Also

Perfoms a Finger query and retrieves the results.

function Finger: String;

Description

Finger connects to a finger server, does the finger query specified in the Query property, and returns the results of the query. Be sure that the Host property is set appropriately before using this method.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.