diff --git a/docs/Functions/BE_ArrayChangeValue.md b/docs/Functions/BE_ArrayChangeValue.md index c935d06a0..7728cf1b5 100644 --- a/docs/Functions/BE_ArrayChangeValue.md +++ b/docs/Functions/BE_ArrayChangeValue.md @@ -4,7 +4,7 @@ **Description** -Changes the array item at valueNumber to newValue in array number array. +Changes the *array* item at *valueNumber* to *newValue*. **Parameters** diff --git a/docs/Functions/BE_ArrayDelete.md b/docs/Functions/BE_ArrayDelete.md index 6bfbbdf7f..3d97ce9f9 100644 --- a/docs/Functions/BE_ArrayDelete.md +++ b/docs/Functions/BE_ArrayDelete.md @@ -4,7 +4,7 @@ **Description** -Removes the array from memory. +Removes *array* from memory. **Parameters** diff --git a/docs/Functions/BE_JSON_ArraySize.md b/docs/Functions/BE_JSON_ArraySize.md index e69de29bb..24a5991b4 100644 --- a/docs/Functions/BE_JSON_ArraySize.md +++ b/docs/Functions/BE_JSON_ArraySize.md @@ -0,0 +1,40 @@ +## BE_JSON_ArraySize + + BE_JSON_ArraySize ( json { ; path } ) + +**Description** + +Will return the number of values in a JSON array. + +**Parameters** + +* *json* : the array to count. +* *name* ( optional ) : the path within the JSON to locate the array to count. + +**Keywords** + +JSON Array Size + +**Version History** + +* 2.1.0 : First Release +* 4.1.0 : Added the optional path parameter + +**Notes** + +If *path* is not included, it counts the array at the root of the JSON, and will return 1 for a non array type. + +If *path* is included, the format is as per the *BE_JSONPath* function, which is NOT the same as the internal FileMaker JSON functions introduced in version 16. + +**Compatibility** + +| Platform | Compatibility | +|-----------|-----------| +| Status | Active | +| Mac FMP | Yes | +| Win FMP | Yes | +| FMS | Yes | +| iOS | Yes | +| Linux | Yes | + +**Example Code** diff --git a/docs/Functions/BE_OpenURL.md b/docs/Functions/BE_OpenURL.md index 4ea61d8cc..879d8ad93 100644 --- a/docs/Functions/BE_OpenURL.md +++ b/docs/Functions/BE_OpenURL.md @@ -12,7 +12,7 @@ Sends the url to the users default web browser. **Keywords** -keyword keyword +URL **Version History** diff --git a/docs/Functions/BE_ValuesUnique.md b/docs/Functions/BE_ValuesUnique.md index 5dadda0e8..8429143c2 100644 --- a/docs/Functions/BE_ValuesUnique.md +++ b/docs/Functions/BE_ValuesUnique.md @@ -13,7 +13,7 @@ Removes duplicate values from listOfValues. **Keywords** -Values Unique +Values Unique List **Version History** diff --git a/docs/Functions/BE_XMLParse.md b/docs/Functions/BE_XMLParse.md index 677c97f9a..247f97842 100644 --- a/docs/Functions/BE_XMLParse.md +++ b/docs/Functions/BE_XMLParse.md @@ -4,7 +4,7 @@ **Description** -Parses an XML file at path to determine if it's properly formed. Does not check XSD details, just whether every tag is properly opened and closed. +Parses an XML file at *pathOrXMLText* to determine if it's properly formed. Does not check XSD details, just whether every tag is properly opened and closed. The result will be empty when successful with a *BE_GetLastError* returning 0. diff --git a/docs/Functions/BE_XMLStripInvalidCharacters.md b/docs/Functions/BE_XMLStripInvalidCharacters.md index e69de29bb..7b96a0aa8 100644 --- a/docs/Functions/BE_XMLStripInvalidCharacters.md +++ b/docs/Functions/BE_XMLStripInvalidCharacters.md @@ -0,0 +1,37 @@ +## BE_XMLStripInvalidCharacters + + BE_XMLStripInvalidCharacters ( path ; { resultFilePath } ) + +**Description** + +This function removes characters considered invalid in XML from the file at *path*, and optionally writes the fixed file to the *resultFilePath*. + +**Parameters** + +* *path* : The path to the text XML file to read. +* *resultFilePath* ( optional, default:path ) : If supplied, this will write the output to a new file. If not supplied then the original file will be overwritten. + +**Keywords** + +XML Strip Invalid Characters + +**Version History** + +* 4.2.0 : First Release + +**Notes** + +Used originally internal as a BaseElements developer tool function, likely not useful for anyone else. + +**Compatibility** + +| Platform | Compatibility | +|-----------|-----------| +| Status | Active | +| Mac FMP | Yes | +| Win FMP | Yes | +| FMS | Yes | +| iOS | Yes | +| Linux | Yes | + +**Example Code** diff --git a/docs/Functions/BE_XPath.md b/docs/Functions/BE_XPath.md index a0ff8fe62..d58b553e6 100644 --- a/docs/Functions/BE_XPath.md +++ b/docs/Functions/BE_XPath.md @@ -4,7 +4,7 @@ **Description** -This finds the first instance of a node at the path xpath within the text xml. +This finds the first instance of a node at the path *xpathText* within the text *xmlText*. **Parameters** @@ -13,7 +13,7 @@ This finds the first instance of a node at the path xpath within the text xml. * *namespaceListText* ( optional ) : Namespace list as "prefix1=href1 prefix2=href2...". * *asTextBoolean* ( optional, default:False ) : Whether to return the XML nodeset as text instead of the standard XPath result. -The *asTextBoolean* parameter when set to True allows you to get raw XML from the source - normally where the XPath function would return a node, with it's opening and closing tag, this will return the value inside that tag instead +The *asTextBoolean* parameter when set to True allows you to get raw XML from the source - normally where the XPath function would return a node, with it's opening and closing tag, this will return the value inside that tag instead. **Keywords** diff --git a/docs/Functions/BE_XPathAll.md b/docs/Functions/BE_XPathAll.md index b70524632..5c0fac054 100644 --- a/docs/Functions/BE_XPathAll.md +++ b/docs/Functions/BE_XPathAll.md @@ -4,7 +4,7 @@ **Description** -This finds all instances of a node at the path xpath within the text xml. Similar to running *BE_XPath* in a loop. +This finds all instances of a node at the path *xpathText* within the text *xmlText*. **Parameters** @@ -18,8 +18,9 @@ XML XPath **Version History** -* 1.0.0 : First Release -* 1.2.0 : +* 1.2.0 : First Release +* 2.2.0 : support objects of type XPATH_BOOLEAN, XPATH_NUMBER and XPATH_STRING +* 2.2.1 : return an empty string when getting an empty node set as xml **Notes** diff --git a/docs/Functions/BE_XSLTApply.md b/docs/Functions/BE_XSLTApply.md index 1ab8bc0ae..234fd43ab 100644 --- a/docs/Functions/BE_XSLTApply.md +++ b/docs/Functions/BE_XSLTApply.md @@ -4,7 +4,7 @@ **Description** -Applies the XSLT given by the xsltText parameter, to the XML file at xmlPath, and writes the output to outputPath. +Applies the XSLT given by the *xsltText* parameter, to the XML file at *xmlFilePath*, and writes the output to *outputFilePath*. **Parameters** @@ -29,7 +29,7 @@ XML XSLT Memory **Notes** -When the scriptName option is used, the script parameter is the response from the XSLT function, if present, and the outputFilePath otherwise. +When the *scriptName* option is used, the script parameter sent to *scriptName* is the response from the XSLT function if present, or the *outputFilePath* otherwise. **Compatibility** diff --git a/docs/Functions/BE_Zip.md b/docs/Functions/BE_Zip.md index 8cb06e965..c54b3d123 100644 --- a/docs/Functions/BE_Zip.md +++ b/docs/Functions/BE_Zip.md @@ -4,14 +4,14 @@ **Description** -Compresses the file(s) found at the filePathList. +Compresses the file(s) found at the *filePathList* and optionally saves the zip file to *archiveFilePath*. **Parameters** * *filePathList* : a plugin file path, or a container field. * *archiveFilePath* : a plugin file path to put the result. -If the *archiveFilePath* parameter is not specified, then the zip file is put into the same folder as first file in the list, and has the .zip extension appended to the filename. This will overwrite an existing file if it exists with that name already. +If the *archiveFilePath* parameter is not specified, then the zip file is put into the same folder as first filename in the list, and has the .zip extension appended to the filename. This will overwrite an existing file if it exists with that name already. **Keywords**