GetDocumentByURL (NotesDatabase - LotusScript®)
Instantiates a document in the database on which it is called and returns a NotesDocument object for it. This method is typically used for either the Server Web Navigator or Personal Web Navigator database, but can be called on any database object.
Defined in
Syntax
Set notesDocument = notesDatabase .GetDocumentByURL( URL$ [, reload ] [, urllist ] [, charset$ ] [, webusername$ ] [, webpassword$ ] [, proxywebusername$ ] [, proxywebpassword$ ] [, returnimmediately ] )
Parameters
URL$
String. The desired uniform resource locator (URL), for example, http://www.acme.com. You can enter a maximum string length of 15K.
reload
Integer. Optional. Enter 1 (True) to reload the page from its Internet server. Enter 0 (False) to load the page from the Internet only if it is not already in the Web Navigator database. Enter 2 to reload the page only if it has been modified on its Internet server. The default value is 0.
urllist
Integer. Optional. Web pages can contain URL links to other Web pages. You can specify whether to save the URLs in a field called URLLinksn in the Notes® document. (The Web Navigator creates a new URLLinksn field each time the field size reaches 64K. For example, the first URLLinks field would be URLLinks1, the second would be URLLinks2, and so on.)
Specify 1 (True) if you want to save the URLs in the URLLinksn field(s). Specify 0 (False) or omit this parameter if you do not want to save the URLs in the URLLinksn field(s). If you save the URLs, you can use them in agents; for example, you could create an agent that opens Web pages in the Web Navigator database and then loads all the Web pages saved in each of the URLLinksn field(s).
charset$
String. Optional. Enter the MIME character set (for example, ISO-2022-JP for Japanese or ISO-8859-1 for United States) that you want the Web Navigator to use when processing the Web page. Only use this parameter when the Web Navigator misdetects the correct MIME character set of the URL contents.
webusername$
String. Optional. Some Internet servers require you to obtain a username before you can access their pages. This parameter allows you to enter the username 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.
returnimmediately
Boolean. Optional. Specify True to return immediately and not wait for completion of the retrieval. Specify False or omit this parameter to wait for completion of the retrieval. If you specify True, GetDocumentByURL does not return the NotesDocument object representing the URL document. This parameter is useful for retrieving a URL document for offline storage purposes; in this case, you do not need the NotesDocument object and do not need to wait for completion of the operation. This parameter is ignored and False is forced if the database being opened is not local to the execution context.
Return value
notesDocument
The NotesDocument that represents the URL document you specified. The return value is Null if returnimmediately is True.