CCookie::getComment

The CCookie::getComment function retrieves the Comment attribute describing the purpose of this cookie.

chchar *getComment();

Return Type

chchar *
Upon successful completion, a string which contains the value of the Comment attribute of the cookie is returned. Otherwise, NULL is returned.

Parameters

None.

Remarks

This function adds retrieves the Comment attribute describing the purpose of this cookie. Because cookies can be used to derive or store private information about a user, the value of the Comment attribute allows an origin server to document how it intends to use the cookie. The user can inspect the information to decide whether to initiate or continue a session with this cookie. Characters in value of Comment attribute MUST be in UTF-8 encoding. [RFC2279]

Attribute of Comment are not supported by Netscape Cookies Version 0.

The CCookie::setComment function can be used to set the Comment attribute of the cookie.