CCookie::setCommentURL

The CCookie::setCommentURL function sets the CommentURL attribute of the cookie.

int setCommentURL(
chchar * comment // containing the value of the CommentURL attribute
);

Return Type

int
Upon successful completion, zero is returned. Otherwise, a value of non-zero is returned.

Parameters

comment
A string containing the value of the CommentURL attribute of the cookie.

Remarks

This function sets the CommentURL attribute of the cookie. Because cookies can be used to derive or store private information about a user, the CommentURL attribute allows an origin server to document how it intends to use the cookie. The user can inspect the information identified by the URL to decide whether to initiate or continue a session with this cookie.

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

The CCookie::getCommentURL function can be used to retrieve the CommentURL attribute of the cookie.