BBjCookie::setComment

Description

In BBj 12.0 and higher, this method sets a comment that describes a cookie's purpose. The comment is useful if the browser presents the cookie to the user. Comments are not supported by Netscape Version 0 cookies.

Syntax

Return Value	Method
void	setComment(string purpose)

Parameters

Variable	Description
purpose	a String specifying the comment to display to the user

Return Value

None.

Remarks

The example below shows setting the purpose of a BBjCookie of a within a BBjServlet

Example

REM Obtain the instance of the BBjAPI object
LET myAPI! = BBjAPI()
MyServlet! = new MyServlet()

data!.setCallback(data!.ON_WEB_CONNECTION, myServlet!, "myMethod")

PROCESS_EVENTS

class public MyServlet
  method public void myMethod(BBjServletEvent p_event!)
    LET chan = UNT
    request! = p_event!.getHttpRequest()
    response! = p_event!.getHttpResponse()
    response!.setContentType("text/html")
    cookie! = response!.addCookie("MyCookie")
    cookie!.setValue("My cookie data")
    cookie!.setPath("/servlet/MyServlet")
    cookie!.setDomain("www.wibble.com")
    cookie!.setMaxAge(3600)
    cookie!.setSecure(0)
    cookie!.setVersion(1)
    cookie!.setComment("comment)
    open (chan)"JSERVLET"
    print (chan)"<html><body><h1>Hello BBj!</h1>"
    print (chan)"</body></html>"
    close (chan)
  methodend
classend