TElCookie.AssembleClientCookie method

TElCookie.AssembleClientCookie

TElCookie See also

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

Produces a cookie string to be passed to the server.

Declaration

[C#]
string AssembleClientCookie(int Format);

[VB.NET]
Function AssembleClientCookie(ByVal Format As Integer) As String

[Pascal]
function AssembleClientCookie(Format : integer) : string;

[C++]
void AssembleClientCookie(int32_t Format, std::string &OutResult);

[PHP]
string AssembleClientCookie(integer $Format)

[Java]
String assembleClientCookie(int Format);

Parameters

Format - the format of the cookie

Possible formats:

[.NET] [Pascal]	[C++]	Description
cfUndefined = 0	SB_cfUndefined = 0	undefined format
cfNetscape = 1	SB_cfNetscape = 1	Netscape cookie format
cfRFC2109 = 2	SB_cfRFC2109 = 2	format defined by RFC 2109
cfRFC2965 = 3	SB_cfRFC2965 = 3	format defined by RFC 2965
cfRFC6265 = 4	SB_cfRFC6265 = 4	format defined by RFC 6265

Return value

Returns a cookie string to be passed to the server.

Description

A client should use this method to assemble client's cookie into a string. Note, that AssembleClientCookie() does not add version number as the first name/value pair, this should be done on higher level, e.g., by TElCookieManager.