GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The HTMLHeaderGetTitle function returns the title of the document as defined by the <TITLE> </TITLE> tag group within the HTML Header.
Syntax/Parameters
Syntax
string = HTMLHeaderGetTitle ( handle hHeader );
string = HTMLHeaderGetTitle ( string html );
Parameters
hHeader
A handle to an HTML Header Object. Or,
html
A string containing an HTML file or HTML header.
Return Value
Returns an string specifying the title. If the string is empty it can indicate an error or an empty title group or no title group. Use the GetLastError or IsError function to retrieve a formatted error code or check for an error respectively.
If the header has no title group or there the object does not have a header, the last error will be ERROR_SOFT.
Remarks
The title of a document is specified by the TITLE element. A document may contain only one title.
Using the string option is an easy way to get the document’s title. However, if the header will be written or access multiple times, the HTML Header Object method is more efficient and effective.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Table of Contents | < < Previous | Next >> |
© 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.