GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Twelve — Internet Functions (continued)

HTTPGetCookies Function

Overview

The HTTPGetCookies function retrieves one or more HTTP cookies that the application received during an HTTP request. The HTTP cookies may be persistent between sessions.

Syntax/Parameters

Syntax

string[][] = HTTPGetCookies ( string site, [string name] )

Parameters

site

A string specifying the site name. This should be a full domain with scheme. In order to retrieve secure cookies the scheme must be secure. For example, “https://www.example.com”.

name

An optional string specifying the name of the cookie to retrieve.

Return Value

A string table containing information about the cookies that matched the site and name, if specified. The function returns an empty set on failure. Use the GetLastError function to get the formatted error code or the HTTP response code and GetLastErrorMessage to return details of the error.

Remarks

The information returned by this function contains the control information for the cookies as well as the cookie data. If only the data for the cookie is needed consider using HTTPGetCookieValue.

	Name			Description
	Cookie Data
		Name		The name of the cookie.
		Value		The data for the cookie.
	Control Information
		Domain		The site or domain of the cookie.
		Path		The relative path of the cookie. This is usually, ‘/’.
		Flags		A string representation of a DWORD value indicating the WinINET flags for the cookie. For more information see: MSDN.
		Expires		A boolean value indicating whether the cookie has an expiration date.
		Expires Time		A string of space separated DWORDs representing the high and low parts of a 64-bit FILETIME. These values represent the date and time the cookie will expire, if any.

 

Related Functions

HTTPGetCookieValue — Retrieves the value of an HTTP cookie that the application received during an HTTP request.

HTTPGetFile — Performs an HTTP “get” operation for the specified URI and saves to the specified file. Optional “no cache” flag. String must specify http or https.

HTTPGetString — Performs an HTTP "get" operation for the specified URI and returns string. The uri parameter must specify an http or https scheme.

HTTPOpenConnection — Sets up for a connection to a specific server for HTTP traffic.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

Page revised 2024-12-13

 

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.