{"type":"doc","content":[{"type":"expand","attrs":{"title":"Version 9 and Older Versions"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 9 (OS 9)","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScriptReferenceManual_ver9.pdf?version=1&modificationDate=1681926520148&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 8 (OS 8)","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScriptReferenceManual%20(ver%208).pdf?version=1&modificationDate=1681851693731&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 7.1","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScript%20Reference%20Manual%20(ver%207.1).pdf?version=1&modificationDate=1681851450896&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 7.0","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScript%20Reference%20Manual%20(ver%207.0).pdf?version=1&modificationDate=1681851517656&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 6.2","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScript%20Reference%20Manual%20(ver%206.2).pdf?version=1&modificationDate=1681851180597&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 6.1","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightSignReferenceManual_V6.1.pdf?version=1&modificationDate=1681851246728&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Previous Versions","type":"text","marks":[{"type":"link","attrs":{"href":"https://support.brightsign.biz/hc/en-us/articles/218067797-Legacy-Documentation-and-User-Guides"}}]},{"text":" ","type":"text"}]}]}]}]},{"type":"expand","attrs":{"title":"Table of Contents"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"indent":{"value":"20px"}},"macroMetadata":{"macroId":{"value":"7d433f91-6b63-4ee4-bd78-09f94ca6d7e0"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"5d190d4e-7b0d-46d9-92a7-54aa6a01ee4c"}}]},{"type":"paragraph","content":[{"text":"BrightScript provides XML support with two BrightScript objects and a set of dedicated language features:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"roXMLElement","type":"text","marks":[{"type":"strong"}]},{"text":": This object provides support for parsing, generating, and containing XML.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"roXMLList","type":"text","marks":[{"type":"strong"}]},{"text":": This object is used to contain a list of ","type":"text"},{"text":"roXMLElement ","type":"text","marks":[{"type":"em"}]},{"text":"instances.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Dot Operator","type":"text"}]},{"type":"paragraph","content":[{"text":"The \".\" ","type":"text"},{"text":"Dot Operator","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/DOC/pages/6525036#Operators-Dot_Operator"}}]},{"text":" has the following features when used with XML objects:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When used with an ","type":"text"},{"text":"roXMLElement","type":"text","marks":[{"type":"em"}]},{"text":" instance, the \".\" Dot Operator returns an ","type":"text"},{"text":"roXMLList ","type":"text","marks":[{"type":"em"}]},{"text":"instance of the child tags that match the dot operand. If no tags match the operand, an empty list is returned.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When applied to an ","type":"text"},{"text":"roXMLList ","type":"text","marks":[{"type":"em"}]},{"text":"instance, the \".\" Dot Operator aggregates the results of performing the above operation on each ","type":"text"},{"text":"roXMLElement ","type":"text","marks":[{"type":"em"}]},{"text":"in the list.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When applied to XML, which is technically case sensitive, the \".\" Dot Operator is still case insensitive. If you wish to perform a case-sensitive XML operation, use the member functions of the ","type":"text"},{"text":"roXMLElement","type":"text","marks":[{"type":"em"}]},{"text":"/","type":"text"},{"text":"roXMLList ","type":"text","marks":[{"type":"em"}]},{"text":"objects.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Attribute Operator","type":"text"}]},{"type":"paragraph","content":[{"text":"The “@” Attribute Operator can be used with an ","type":"text"},{"text":"roXMLElement ","type":"text","marks":[{"type":"em"}]},{"text":"instance to return a named attribute. Though XML is case sensitive, the Attribute Operator is always case insensitive. If the Attribute Operator is used with an ","type":"text"},{"text":"roXMLList","type":"text","marks":[{"type":"em"}]},{"text":" instance, it will only return a value if that list contains exactly one element.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Examples","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n \n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"Given the XML in the above ","type":"text"},{"text":"example.xml","type":"text","marks":[{"type":"em"}]},{"text":" file, then the following code will return an ","type":"text"},{"text":"roXMLList ","type":"text","marks":[{"type":"em"}]},{"text":"instance with three entries:","type":"text"}]},{"type":"codeBlock","content":[{"text":"rsp=CreateObject(\"roXMLElement\")\nrsp.Parse(ReadAsciiFile(\"example.xml\"))\n \n? rsp.photos.photo","type":"text"}]},{"type":"paragraph","content":[{"text":"The following will return an ","type":"text"},{"text":"roXMLElement","type":"text","marks":[{"type":"em"}]},{"text":" reference to the first photo (id=\"","type":"text"},{"text":"3131875696","type":"text","marks":[{"type":"strong"}]},{"text":"\"):","type":"text"}]},{"type":"codeBlock","content":[{"text":"? rsp.photos.photo[0]","type":"text"}]},{"type":"paragraph","content":[{"text":"The following will return an ","type":"text"},{"text":"roXMLList ","type":"text","marks":[{"type":"em"}]},{"text":"reference containing the tag:","type":"text"}]},{"type":"codeBlock","content":[{"text":"? rsp.photos","type":"text"}]},{"type":"paragraph","content":[{"text":"The following will return the string “100”:","type":"text"}]},{"type":"codeBlock","content":[{"text":"rsp.photos@perpage","type":"text"}]},{"type":"paragraph","content":[{"text":"You can use the ","type":"text"},{"text":"roXMLElement.GetText()","type":"text","marks":[{"type":"em"}]},{"text":" method to return an element’s text: For example, if the variable ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" contains the element ","type":"text"},{"text":"The Dawn of Man","type":"text","marks":[{"type":"code"}]},{"text":", then the following code will print the string “The Dawn of Man”.","type":"text"}]},{"type":"codeBlock","content":[{"text":"Print booklist.book.gettext()","type":"text"}]},{"type":"paragraph","content":[{"text":"Alternatively, using the Attribute Operator will print the string “eng”.","type":"text"}]},{"type":"codeBlock","content":[{"text":"print booklist.book@lang","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Flikr code clip","type":"text","marks":[{"type":"textColor","attrs":{"color":"#3d3d3d"}}]}]},{"type":"codeBlock","content":[{"text":"REM\nREM Interestingness\nREM pass an (optional) page of value 1 - 5 to get 100 photos\nREM starting at 0/100/200/300/400\nREM\nREM returns a list of \"Interestingness\" photos with 100 entries\nREM\n\n\nFunction GetInterestingnessPhotoList(http as Object, page=1 As Integer) As Object\n\n\n\tprint \"page=\";page\n\n\n http.SetUrl(\"http://api.flickr.com/services/rest/?method=flickr.interestingness.getList&api_key=YOURKEYGOESHERE&page=\"+mid(stri(page),2))\n\n\n xml=http.GetToString()\n\n\n rsp=CreateObject(\"roXMLElement\")\n if not rsp.Parse(xml) then stop\n\n return helperPhotoListFromXML(http, rsp.photos.photo) 'rsp.GetBody().Peek().GetBody())\n\n \nEnd Function\n\n\nFunction helperPhotoListFromXML(http As Object, xmllist As Object, owner=invalid As dynamic) As Object\n\n\n photolist=CreateObject(\"roList\")\n for each photo in xmllist\n photolist.Push(newPhotoFromXML(http, photo, owner))\n end for\n return photolist\n\n\nEnd Function\n\n\nREM\nREM newPhotoFromXML\nREM\nREM Takes an roXMLElement Object that is an ... \nREM Returns an brs object of type Photo\nREM photo.GetTitle()\nREM photo.GetID()\nREM photo.GetURL()\nREM photo.GetOwner()\nREM\n\n\nFunction newPhotoFromXML(http As Object, xml As Object, owner As dynamic) As Object\n photo = CreateObject(\"roAssociativeArray\")\n photo.http=http\n photo.xml=xml\n photo.owner=owner\n photo.GetTitle=function():return m.xml@title:end function\n photo.GetID=function():return m.xml@id:end function\n photo.GetOwner=pGetOwner\n photo.GetURL=pGetURL\n return photo\nEnd Function\n\n\nFunction pGetOwner() As String\n\tif m.owner<>invalid return m.owner\n\treturn m.xml@owner\nEnd Function\n\n\nFunction pGetURL() As String\n\ta=m.xml.GetAttributes()\n\turl=\"http://farm\"+a.farm+\".static.flickr.com/\"+a.server+\"/\"+a.id+\"_\"+a.secret+\".jpg\"\n\treturn url\nEnd Function","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported