GetURLHeaderInfo (NotesDatabase - LotusScript®)

Gets the specific Hypertext Transfer Protocol (HTTP) header information from the Uniform Resource Locator (URL). A URL is a text string used for identifying and addressing a Web resource.

Note: This method is obsolete in Release 6.

Defined in

NotesDatabase

Syntax

header$ = notesDatabase .GetURLHeaderInfo( URL$ , headername$ [, Webusername$ ] [, Webpassword$ ] [, Proxywebusername$ ] [, Proxywebpassword$ ] )

Parameters

URL$

Note: This parameter is optional in COM.

String. The URL for the Web page for which you want information , for example, http://www.acme.com/. You can enter a maximum string length of 15K.

headername$

Note: This parameter is optional in COM.

String. Enter a header string of the URL header value that you want returned. The acceptable header strings are documented in the HTTP specification (available at various locations on the Internet, such as http://www.w3.org/) and are subject to change based on updated versions of the specification.

Webusername$

String. Optional. Some Internet servers require you to obtain a user name before you can access their pages. This parameter allows you to enter the user name that you previously obtained from the Internet server.

Webpassword$

String. Optional. Some Internet servers require you to obtain a password before you can access their pages. This parameter allows you to enter the password that you previously obtained from the Internet server.

Proxywebusername$

String. Optional. Some proxy servers require that you specify a user name in order to connect through them. This parameter allows you to enter the user name for the proxy server. See your administrator for the user name required by the proxy.

Proxywebpassword$

String. Optional. Some proxy servers require that you specify a password in order to connect through them. This parameter allows you to enter the password for the proxy server. See your administrator for the password required by the proxy.

Return value

header$

String. The requested header. If a null value is returned, the header value that you requested was not found in the header of the URL, or the URL could not be found.

Usage

All HTTP (and META) Header names are converted so that any dashes they contain became underscores (so they can be used in Views, etc.). Previously, this required all LotusScript® users to convert all dashes to underscores manually. Now, with Release 5, all dashes are automatically converted to underscores.

Example