sa_conn_props


Purpose

Gets the value of a connection property.

Syntax

sa_conn_props (connection, action, property, buffer, buflen, outlen);

SA_CONN *connection;
SA_INT action;
SA_INT property;
SA_BYTE *buffer;
SA_INT buflen;
SA_INT *outlen;

Parameters

connection Server connection.
action Specify SA_GET to retrieve the value of a property.
property The property whose value is being retrieved. Specify one of the following constants:

SA_CONNPROP_AGENT - the client browser (for example, "Mozilla/3.0 (Win95; I)").

SA_CONNPROP_HOST - the client host name; either the IP address or, if DNS is enabled, the symbolic name.

SA_CONNPROP_REFERER - the URL from which the request was made.

SA_CONNPROP_REQUEST - the URI or RPC being requested.

In contrast to a URL, a URI does not associate any arguments with a request.

SA_CONNPROP_REQUESTMETHOD - the method by which the request was made (for example, GET or POST).

buffer The buffer into which to receive the parameter value.

buflen The length of buffer. Specify a length sufficient to hold the value returned in buffer. If the buffer is too small, sa_conn_props will fail.

outlen The actual length of the value returned in buffer.

Returns

SA_SUCCEED if the function is successful; SA_FAIL otherwise.

Comments

None

See Also

sa_ctx_props