Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This routine is available starting with SIL Engine™ 4.1.0.
Info
titleAvailability
Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

httpOptions(url, request

...

Starting with SIL Engine™ 4.5.0:

...

[, proxy])

Package

http

...

Alias

Pkg Usage

options(

...

url, request [, proxy])

Description

Excerpt
hiddentrue
Executes an HTTP OPTIONS for the given URL using the specified HttpRequest object.

Executes an HTTP OPTIONS for the given URL using the specified HttpRequest object. Returns the message body of the response converted to the requested left operand type (if any).

...

Requests can also be sent through a proxy.

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

url

...

String

Yes

The URL.

request

HttpRequest

Yes

An HttpRequest object containing headers, cookies, parameters.

proxy

HttpProxy

No

An HttpProxy object containing the host and port of the proxy server.

The request parameter should have the HttpRequest type described here. The HttpProxy type is described here.

Return type

...

Return Type

String

Variable return type depends on the left hand side operator type.

Example

Code Block
HttpRequest request;
request.headers += httpCreateHeader("Host", "cprime.com");
string url = "http://example.org";
httpOptions(url, request);
number statusCode = httpGetStatusCode();
if (statusCode >statusCode>= 200 && statusCode < 300) {
	return httpGetHeader("Allow");
}

Note

The request parameter should have the HttpRequest type described here. The HttpProxy type is described here.

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "http_support"routine" and space = currentSpace ( )
labelsjiraarray_project_routineroutines