🕷️ Crawler Inspector

URL Lookup

Direct Parameter Lookup

Raw Queries and Responses

1. Shard Calculation

Query:

Response:

Calculated Shard: 199 (from laksa027)

2. Crawled Status Check

Query:

curl -X POST \
  'http://laksa199.int.ahrefs:8124/' \
  -H 'Content-Type: text/plain' \
  -H 'X-ClickHouse-Database: crawler3' \
  -H 'Authorization: Basic YXBpOg==' \
  -d 'SELECT getAhrefsURLFromUnparsed(src_unparsed) AS found_url, ifNull(toUnixTimestamp(download_stamp), 0) AS crawl_time, ifNull(toUnixTimestamp(props_url_first_seen), 0) AS first_indexed_time, download_http_code AS http_code, src_unparsed AS src_unparsed, src_root_hash AS src_root_hash, history_drop_reason AS history_drop_reason, meta_title AS meta_title, meta_descriptions AS meta_descriptions, attrs_boilerpipe_text AS attrs_boilerpipe_text, attrs_markdown AS attrs_markdown, attrs_readable_markdown AS attrs_readable_markdown, meta_canonical AS meta_canonical FROM crawler3.page_info_local FINAL PREWHERE (src_root_hash, src_unparsed) IN ((getAhrefsRootHashFromUnparsed(getAhrefsUnparsedNoserviceFromURL(\'https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_syntax.html\')), getAhrefsUnparsedNoserviceFromURL(\'https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_syntax.html\'))) FORMAT JSONEachRow'

Response:

{"found_url":"https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_syntax.html","crawl_time":1776025041,"first_indexed_time":1542648998,"http_code":200,"src_unparsed":"com,4js!\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_syntax.html s443","src_root_hash":"14951230760913715399","history_drop_reason":null,"meta_title":"FUNCTION definitions","meta_descriptions":["A FUNCTION definition defines a named procedure with a set of statements."],"attrs_boilerpipe_text":"A\nFUNCTION\ndefinition defines a named procedure with a set of\nstatements.\nSyntax 1 (legacy function syntax):\n[\nPUBLIC\n|\nPRIVATE\n]\nFUNCTION\nfunction-name\n(\n[\nparameter-name\n[\n,\n...]\n]\n)\n[\nDEFINE\nparameter-name\ntype-specification\n[\n,\n...]\n]\n[\nlocal-declaration\n[...]\n]\n[\ninstruction\n|\n[\nRETURN\nexpression\n[\n,\n...]\n]\n[...]\n]\nEND FUNCTION\nfunction-name\nis the function identifier.\nparameter-name\nis the name of a formal argument of the function.\ntype-specification\ncan be one of:\nA\nprimitive type\nA\nrecord definition\nAn\narray definition\nA\ndictionary definition\nA\nfunction type definition\nThe name of a\nuser defined type\nThe name of a\nbuilt-in class\nThe name of an\nimported extension\nclass\nThe name of an\nimported Java class\nlocal-declaration\nis a\nDEFINE\n,\nCONSTANT\nor\nTYPE\ninstruction.\ninstruction\nis a language statement to be executed when the function is\ninvoked.\nexpression\nis a value to be returned by the function.\nSyntax 2 (fully typed function):\n[\nPUBLIC\n|\nPRIVATE\n]\nFUNCTION\nfunction-name\n(\n{\nparameter-name\ntype-specification\n[\nattributes-list\n]\n|\nrecord-name\nrecord-type\nINOUT\n}\n[\n,\n...]\n)\n[\nattributes-list\n]\n[\nRETURNS\nreturns-specification\n]\n[\nlocal-declaration\n[...]\n]\n[\ninstruction\n|\n[\nRETURN\nexpression\n[\n,\n...]\n]\n[...]\n]\nEND FUNCTION\nwhere\nreturns-specification\nis:\n{\ntype-specification\n[\nattributes-list\n]\n|\n(\ntype-specification\n[\nattributes-list\n]\n[\n,\n...]\n)\n|\n( )\n}\nfunction-name\nis the identifier of the function, that must follow the\nconvention for\nidentifiers\n.\nparameter-name\nis the name of a formal argument of the function.\ntype-specification\ncan be one of:\nA\nprimitive type\nA\nrecord definition\nAn\narray definition\nA\ndictionary definition\nA\nfunction type definition\nThe name of a\nuser defined type\nThe name of a\nbuilt-in class\nThe name of an\nimported extension\nclass\nThe name of an\nimported Java class\nrecord-name\nis the name of a parameter defined as\nrecord-type\n.\nrecord-type\nis a the name of a user-defined\nTYPE\ndeclared as a\nRECORD\nstructure.\nattributes-list\nis a comma-separated list of\nname = value\npairs or\nname\nattributes, and defines\nattributes for the function\n.\nlocal-declaration\nis a\nDEFINE\n,\nCONSTANT\nor\nTYPE\ninstruction.\ninstruction\nis a language statement to be executed when the function is\ninvoked.\nexpression\nis a value to be returned by the function.\nSyntax 3 (methods):\n[\nPUBLIC\n|\nPRIVATE\n]\nFUNCTION (\nreceiver-name\nreceiver-type\n)\nmethod-name\n(\n{\nparameter-name\ntype-specification\n|\nrecord-name\nrecord-type\nINOUT\n}\n[\n,\n...]\n)\n[\nRETURNS\nreturns-specification\n]\n[\nlocal-declaration\n[...]\n]\n[\ninstruction\n|\n[\nRETURN\nexpression\n[\n,\n...]\n]\n[...]\n]\nEND FUNCTION\nwhere\nreturns-specification\nis:\n{\ntype-specification\n|\n(\ntype-specification\n[\n,\n...]\n)\n|\n( )\n}\nA\n(\nreceiver-name\nreceiver-type\n)\nclause\ndefines a function as a method for a user-defined type.\nreceiver-name\nis the identifier of the receiver referenced in the method\nbody.\nreceiver-type\nis the user-defined type to be the target of this method.\nmethod-name\nis the identifier of the method.\nparameter-name\nis the name of a formal argument of the method.\ntype-specification\ncan be one of:\nA\nprimitive type\nA\nrecord definition\nAn\narray definition\nA\ndictionary definition\nA\nfunction type definition\nThe name of a\nuser defined type\nThe name of a\nbuilt-in class\nThe name of an\nimported extension\nclass\nThe name of an\nimported Java class\nrecord-name\nis the name of a parameter defined with a record\nTYPE\n.\nrecord-type\nis a the name of a user-defined\nTYPE\ndeclared as a\nRECORD\nstructure.\nlocal-declaration\nis a\nDEFINE\n,\nCONSTANT\nor\nTYPE\ninstruction.\ninstruction\nis a language statement to be executed when the method is\ninvoked.\nexpression\nis a value to be returned by the method.\nFunction names\nLike other identifiers, function names are case-insensitive. However, always consider using the\nsame naming convention when defining and invoking functions.\nIf the function name is also the name of a built-in function, an error occurs at link time, even\nif the program does not reference the built-in function.\nFunction definition using legacy syntax\nThe following example shows a function definition using the legacy syntax, with parameter\ndefinition in the function body:\nFUNCTION split(str, len)\n    DEFINE str STRING, len INT\n    RETURN str.subString(1, len),\n           str.subString(len+1, str.getLength())\nEND FUNCTION\nThis syntax does not define a function with a complete signature.\nFunction definition with complete function type\nBy specifying data types in the parameter list, you define a function with a complete function\ntype.\nThis syntax allows better compilation\nchecking:\nFUNCTION split(str STRING, len INT) RETURNS (STRING, STRING)\n    RETURN str.subString(1, len),\n           str.subString(len+1, str.getLength())\nEND FUNCTION\nBraces after the\nRETURNS\nclause are not required, when the function returns a\nsingle\nvalue:\nFUNCTION count_items(sid INT) RETURNS INT\n    DEFINE cnt INT\n    SELECT COUNT(*) INTO cnt FROM stock WHERE stock_id = sid\n    RETURN cnt\nEND FUNCTION\nWhen the function returns a single value\/type, it is also possible to enclose the type in\nparentheses:\nFUNCTION count_items(sid INT) RETURNS (INT)\n    ...\nIn the next example, the function has no parameters and does not return values:\nFUNCTION clean_debug_log() RETURNS ()\n    CALL os.Path.delete(\"log.txt\")\nEND FUNCTION\nMethods\nA\nFUNCTION\ndefinition using a receiver identifier and type defines a method for\nthis type. Specify the receiver identifier and type before the method\nname:\nTYPE Rectangle RECORD\n    height, width DOUBLE PRECISION\nEND RECORD\n\nFUNCTION (r Rectangle) area() RETURNS DOUBLE PRECISION\n    RETURN r.height * r.width\nEND FUNCTION\nFor more details see\nMethods\n.\nFunction with record passed as reference\nThe\nINOUT\nkeyword can be used to pass records by reference:\nFUNCTION init_cust(r CustRec INOUT)\n    LET r.cust_id = 0\n    LET r.cust_name = \"<undefined>\"\n    LET r.cust_addr = \"<undefined>\"\n    LET r.cust_crea = CURRENT\nEND FUNCTION\nFor more details see\nFunction parameters\n.\nFunction with attributes\nFunction attributes can be used to complete the definition of the function itself, for its\nparameters and return values:\nFUNCTION add(\n    p1 INTEGER ATTRIBUTES(json_name = \"parameter 1\"),\n    p2 INTEGER ATTRIBUTES(json_name = \"parameter 2\")\n    )\n    ATTRIBUTES(json_name = \"function add\")\n    RETURNS INTEGER ATTRIBUTES(json_name = \"return value 1\")\n        DEFINE var1 INTEGER\n        LET var1 = (p1 + p2)\n        RETURN var1\nEND FUNCTION\nFunction attributes are especially useful to implement\nRESTful\nWeb Services functions\n.\nFor more details see\nFunction attributes\n.","attrs_markdown":"|   |   |\n|---|---|\n| [Language basics](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_language_basics.html \"These topics cover the basics for the Genero Business Development Language (BDL)\")[Functions](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_001.html \"Describes user defined functions.\") | [Parent topic: Functions](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_001.html \"Describes user defined functions.\") |\n\n# FUNCTION definitions\nA `FUNCTION` definition defines a named procedure with a set of statements.\n\n## Syntax 1 (legacy function syntax):\n```\n[PUBLIC|PRIVATE] FUNCTION function-name ( [ parameter-name [,...] ] )\n    [ DEFINE parameter-name type-specification [,...] ]\n    [ local-declaration [...] ]\n    [ instruction \n    | [ RETURN expression [,...] ]\n        [...] \n    ]\nEND FUNCTION\n```\n1. function-name\n   is the function identifier.\n2. parameter-name\n   is the name of a formal argument of the function.\n3. type-specification\n   can be one of:\n   - A [primitive type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_variables_primitive_type.html \"Type definitions using a primitive data type define a primitive type.\")\n   - A [record definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_records_002.html \"The RECORD keyword defines a structured type or variable.\")\n   - An [array definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Arrays_002.html \"An array defines a vector variable with a list of elements.\")\n   - A [dictionary definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Dictionary_syntax.html \"A dictionary defines an associative array (hash-map) of elements.\")\n   - A [function type definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_references.html \"Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.\")\n   - The name of a [user defined type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_003.html \"Types define a synonym for a base or structured data type.\")\n   - The name of a [built-in class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_built_in_classes.html \"These topics cover the built-in classes provided by the Genero Business Development Language.\")\n   - The name of an [imported extension class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_extension_packages.html \"Several utility classes and functions are provided in additional packages.\")\n   - The name of an [imported Java class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_JavaBridge_001.html \"The Java interface allows you to import Java classes and instantiate Java objects in your programs.\")\n4. local-declaration\n   is a `DEFINE`, `CONSTANT` or `TYPE` instruction.\n5. instruction\n   is a language statement to be executed when the function is invoked.\n6. expression\n   is a value to be returned by the function.\n\n## Syntax 2 (fully typed function):\n```\n[PUBLIC|PRIVATE] FUNCTION function-name (\n     { parameter-name type-specification [ attributes-list ]\n     | record-name record-type INOUT\n     }\n     [,...]\n  )\n [ attributes-list ]\n [ RETURNS returns-specification ]\n    [ local-declaration [...] ]\n    [ instruction \n    | [ RETURN expression [,...] ]\n        [...] \n    ]\nEND FUNCTION\n```\nwhere\n\nreturns-specification\n\nis:\n```\n{ type-specification [ attributes-list ]\n| ( type-specification [ attributes-list ] [,...] )\n| ( )\n}\n```\n\n1. function-name\n   is the identifier of the function, that must follow the convention for [identifiers](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_language_features_identifiers.html \"A Genero BDL identifier is a sequence of characters used to identify a program entity.\").\n2. parameter-name\n   is the name of a formal argument of the function.\n3. type-specification\n   can be one of:\n   - A [primitive type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_variables_primitive_type.html \"Type definitions using a primitive data type define a primitive type.\")\n   - A [record definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_records_002.html \"The RECORD keyword defines a structured type or variable.\")\n   - An [array definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Arrays_002.html \"An array defines a vector variable with a list of elements.\")\n   - A [dictionary definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Dictionary_syntax.html \"A dictionary defines an associative array (hash-map) of elements.\")\n   - A [function type definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_references.html \"Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.\")\n   - The name of a [user defined type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_003.html \"Types define a synonym for a base or structured data type.\")\n   - The name of a [built-in class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_built_in_classes.html \"These topics cover the built-in classes provided by the Genero Business Development Language.\")\n   - The name of an [imported extension class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_extension_packages.html \"Several utility classes and functions are provided in additional packages.\")\n   - The name of an [imported Java class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_JavaBridge_001.html \"The Java interface allows you to import Java classes and instantiate Java objects in your programs.\")\n4. record-name\n   is the name of a parameter defined as\n   record-type\n   .\n5. record-type\n   is a the name of a user-defined [`TYPE`](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_001.html \"Types can be defined by the programmer to centralize the definition of complex\/structured variables.\") declared as a [`RECORD`](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_records_002.html \"The RECORD keyword defines a structured type or variable.\") structure.\n6. attributes-list\n   is a comma-separated list of\n   name = value\n   pairs or\n   name\n   attributes, and defines [attributes for the function](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_attributes.html \"Function attributes can be used to add definition information about the function, its parameters and its return values.\").\n7. local-declaration\n   is a `DEFINE`, `CONSTANT` or `TYPE` instruction.\n8. instruction\n   is a language statement to be executed when the function is invoked.\n9. expression\n   is a value to be returned by the function.\n\n## Syntax 3 (methods):\n```\n[PUBLIC|PRIVATE] FUNCTION ( receiver-name receiver-type ) method-name (\n     { parameter-name type-specification\n     | record-name record-type INOUT\n     }\n     [,...]\n  )\n [ RETURNS returns-specification ]\n    [ local-declaration [...] ]\n    [ instruction \n    | [ RETURN expression [,...] ]\n        [...] \n    ]\nEND FUNCTION\n```\nwhere\n\nreturns-specification\n\nis:\n```\n{ type-specification\n| ( type-specification [,...] )\n| ( )\n}\n```\n\n1. A `(receiver-name receiver-type)` clause defines a function as a method for a user-defined type.\n2. receiver-name\n   is the identifier of the receiver referenced in the method body.\n3. receiver-type\n   is the user-defined type to be the target of this method.\n4. method-name\n   is the identifier of the method.\n5. parameter-name\n   is the name of a formal argument of the method.\n6. type-specification\n   can be one of:\n   - A [primitive type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_variables_primitive_type.html \"Type definitions using a primitive data type define a primitive type.\")\n   - A [record definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_records_002.html \"The RECORD keyword defines a structured type or variable.\")\n   - An [array definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Arrays_002.html \"An array defines a vector variable with a list of elements.\")\n   - A [dictionary definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Dictionary_syntax.html \"A dictionary defines an associative array (hash-map) of elements.\")\n   - A [function type definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_references.html \"Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.\")\n   - The name of a [user defined type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_003.html \"Types define a synonym for a base or structured data type.\")\n   - The name of a [built-in class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_built_in_classes.html \"These topics cover the built-in classes provided by the Genero Business Development Language.\")\n   - The name of an [imported extension class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_extension_packages.html \"Several utility classes and functions are provided in additional packages.\")\n   - The name of an [imported Java class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_JavaBridge_001.html \"The Java interface allows you to import Java classes and instantiate Java objects in your programs.\")\n7. record-name\n   is the name of a parameter defined with a record `TYPE`.\n8. record-type\n   is a the name of a user-defined [`TYPE`](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_001.html \"Types can be defined by the programmer to centralize the definition of complex\/structured variables.\") declared as a `RECORD` structure.\n9. local-declaration\n   is a `DEFINE`, `CONSTANT` or `TYPE` instruction.\n10. instruction\n    is a language statement to be executed when the method is invoked.\n11. expression\n    is a value to be returned by the method.\n\n## Function names\nLike other identifiers, function names are case-insensitive. However, always consider using the same naming convention when defining and invoking functions.\n\nIf the function name is also the name of a built-in function, an error occurs at link time, even if the program does not reference the built-in function.\n\n## Function definition using legacy syntax\nThe following example shows a function definition using the legacy syntax, with parameter definition in the function body:\n```\nFUNCTION split(str, len)\n    DEFINE str STRING, len INT\n    RETURN str.subString(1, len),\n           str.subString(len+1, str.getLength())\nEND FUNCTION\n```\n\nThis syntax does not define a function with a complete signature.\n\n## Function definition with complete function type\nBy specifying data types in the parameter list, you define a function with a complete function type.\n\nThis syntax allows better compilation checking:\n```\nFUNCTION split(str STRING, len INT) RETURNS (STRING, STRING)\n    RETURN str.subString(1, len),\n           str.subString(len+1, str.getLength())\nEND FUNCTION\n```\n\nBraces after the `RETURNS` clause are not required, when the function returns a single value:\n```\nFUNCTION count_items(sid INT) RETURNS INT\n    DEFINE cnt INT\n    SELECT COUNT(*) INTO cnt FROM stock WHERE stock_id = sid\n    RETURN cnt\nEND FUNCTION\n```\n\nWhen the function returns a single value\/type, it is also possible to enclose the type in parentheses:\n```\nFUNCTION count_items(sid INT) RETURNS (INT)\n    ...\n```\nIn the next example, the function has no parameters and does not return values:\n```\nFUNCTION clean_debug_log() RETURNS ()\n    CALL os.Path.delete(\"log.txt\")\nEND FUNCTION\n```\n\n## Methods\nA `FUNCTION` definition using a receiver identifier and type defines a method for this type. Specify the receiver identifier and type before the method name:\n```\nTYPE Rectangle RECORD\n    height, width DOUBLE PRECISION\nEND RECORD\n\nFUNCTION (r Rectangle) area() RETURNS DOUBLE PRECISION\n    RETURN r.height * r.width\nEND FUNCTION\n```\n\nFor more details see [Methods](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_methods.html \"A function declared with a receiver type defines a method for this type.\").\n\n## Function with record passed as reference\nThe `INOUT` keyword can be used to pass records by reference:\n```\nFUNCTION init_cust(r CustRec INOUT)\n    LET r.cust_id = 0\n    LET r.cust_name = \"<undefined>\"\n    LET r.cust_addr = \"<undefined>\"\n    LET r.cust_crea = CURRENT\nEND FUNCTION\n```\nFor more details see [Function parameters](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_parameters.html \"Functions can take parameters, to specialize their behavior.\").\n\n## Function with attributes\nFunction attributes can be used to complete the definition of the function itself, for its parameters and return values:\n```\nFUNCTION add(\n    p1 INTEGER ATTRIBUTES(json_name = \"parameter 1\"),\n    p2 INTEGER ATTRIBUTES(json_name = \"parameter 2\")\n    )\n    ATTRIBUTES(json_name = \"function add\")\n    RETURNS INTEGER ATTRIBUTES(json_name = \"return value 1\")\n        DEFINE var1 INTEGER\n        LET var1 = (p1 + p2)\n        RETURN var1\nEND FUNCTION\n```\nFunction attributes are especially useful to implement [RESTful Web Services functions](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_gws_restful.html \"With Genero Business Development Language, you can code a RESTful Web Services client or server application using low-level APIs.\").\n\nFor more details see [Function attributes](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_attributes.html \"Function attributes can be used to add definition information about the function, its parameters and its return values.\").\n\n**Related concepts**\n\n[Variables](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_variables_001.html \"Explains how to define program variables.\")\n\n[Expressions](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Expressions_001.html \"Shows the possible expressions supported in the language.\")\n\n[Commenting a function](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_AutoDoc_007.html \"Commenting a function\")\n\n[Parent topic: Functions](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_001.html \"Describes user defined functions.\")","attrs_readable_markdown":"A `FUNCTION` definition defines a named procedure with a set of statements.\n\n## Syntax 1 (legacy function syntax):\n```\n[PUBLIC|PRIVATE] FUNCTION function-name ( [ parameter-name [,...] ] )\n    [ DEFINE parameter-name type-specification [,...] ]\n    [ local-declaration [...] ]\n    [ instruction \n    | [ RETURN expression [,...] ]\n        [...] \n    ]\nEND FUNCTION\n```\n1. function-name\n   is the function identifier.\n2. parameter-name\n   is the name of a formal argument of the function.\n3. type-specification\n   can be one of:\n   - A [primitive type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_variables_primitive_type.html \"Type definitions using a primitive data type define a primitive type.\")\n   - A [record definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_records_002.html \"The RECORD keyword defines a structured type or variable.\")\n   - An [array definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Arrays_002.html \"An array defines a vector variable with a list of elements.\")\n   - A [dictionary definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Dictionary_syntax.html \"A dictionary defines an associative array (hash-map) of elements.\")\n   - A [function type definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_references.html \"Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.\")\n   - The name of a [user defined type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_003.html \"Types define a synonym for a base or structured data type.\")\n   - The name of a [built-in class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_built_in_classes.html \"These topics cover the built-in classes provided by the Genero Business Development Language.\")\n   - The name of an [imported extension class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_extension_packages.html \"Several utility classes and functions are provided in additional packages.\")\n   - The name of an [imported Java class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_JavaBridge_001.html \"The Java interface allows you to import Java classes and instantiate Java objects in your programs.\")\n4. local-declaration\n   is a `DEFINE`, `CONSTANT` or `TYPE` instruction.\n5. instruction\n   is a language statement to be executed when the function is invoked.\n6. expression\n   is a value to be returned by the function.\n\n## Syntax 2 (fully typed function):\n```\n[PUBLIC|PRIVATE] FUNCTION function-name (\n     { parameter-name type-specification [ attributes-list ]\n     | record-name record-type INOUT\n     }\n     [,...]\n  )\n [ attributes-list ]\n [ RETURNS returns-specification ]\n    [ local-declaration [...] ]\n    [ instruction \n    | [ RETURN expression [,...] ]\n        [...] \n    ]\nEND FUNCTION\n```\nwhere returns-specification is:\n```\n{ type-specification [ attributes-list ]\n| ( type-specification [ attributes-list ] [,...] )\n| ( )\n}\n```\n\n1. function-name\n   is the identifier of the function, that must follow the convention for [identifiers](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_language_features_identifiers.html \"A Genero BDL identifier is a sequence of characters used to identify a program entity.\").\n2. parameter-name\n   is the name of a formal argument of the function.\n3. type-specification\n   can be one of:\n   - A [primitive type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_variables_primitive_type.html \"Type definitions using a primitive data type define a primitive type.\")\n   - A [record definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_records_002.html \"The RECORD keyword defines a structured type or variable.\")\n   - An [array definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Arrays_002.html \"An array defines a vector variable with a list of elements.\")\n   - A [dictionary definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Dictionary_syntax.html \"A dictionary defines an associative array (hash-map) of elements.\")\n   - A [function type definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_references.html \"Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.\")\n   - The name of a [user defined type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_003.html \"Types define a synonym for a base or structured data type.\")\n   - The name of a [built-in class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_built_in_classes.html \"These topics cover the built-in classes provided by the Genero Business Development Language.\")\n   - The name of an [imported extension class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_extension_packages.html \"Several utility classes and functions are provided in additional packages.\")\n   - The name of an [imported Java class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_JavaBridge_001.html \"The Java interface allows you to import Java classes and instantiate Java objects in your programs.\")\n4. record-name\n   is the name of a parameter defined as\n   record-type\n   .\n5. record-type\n   is a the name of a user-defined [`TYPE`](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_001.html \"Types can be defined by the programmer to centralize the definition of complex\/structured variables.\") declared as a [`RECORD`](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_records_002.html \"The RECORD keyword defines a structured type or variable.\") structure.\n6. attributes-list\n   is a comma-separated list of\n   name = value\n   pairs or\n   name\n   attributes, and defines [attributes for the function](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_attributes.html \"Function attributes can be used to add definition information about the function, its parameters and its return values.\").\n7. local-declaration\n   is a `DEFINE`, `CONSTANT` or `TYPE` instruction.\n8. instruction\n   is a language statement to be executed when the function is invoked.\n9. expression\n   is a value to be returned by the function.\n\n## Syntax 3 (methods):\n```\n[PUBLIC|PRIVATE] FUNCTION ( receiver-name receiver-type ) method-name (\n     { parameter-name type-specification\n     | record-name record-type INOUT\n     }\n     [,...]\n  )\n [ RETURNS returns-specification ]\n    [ local-declaration [...] ]\n    [ instruction \n    | [ RETURN expression [,...] ]\n        [...] \n    ]\nEND FUNCTION\n```\nwhere returns-specification is:\n```\n{ type-specification\n| ( type-specification [,...] )\n| ( )\n}\n```\n\n1. A `(receiver-name receiver-type)` clause defines a function as a method for a user-defined type.\n2. receiver-name\n   is the identifier of the receiver referenced in the method body.\n3. receiver-type\n   is the user-defined type to be the target of this method.\n4. method-name\n   is the identifier of the method.\n5. parameter-name\n   is the name of a formal argument of the method.\n6. type-specification\n   can be one of:\n   - A [primitive type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_variables_primitive_type.html \"Type definitions using a primitive data type define a primitive type.\")\n   - A [record definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_records_002.html \"The RECORD keyword defines a structured type or variable.\")\n   - An [array definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Arrays_002.html \"An array defines a vector variable with a list of elements.\")\n   - A [dictionary definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Dictionary_syntax.html \"A dictionary defines an associative array (hash-map) of elements.\")\n   - A [function type definition](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_references.html \"Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.\")\n   - The name of a [user defined type](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_003.html \"Types define a synonym for a base or structured data type.\")\n   - The name of a [built-in class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_built_in_classes.html \"These topics cover the built-in classes provided by the Genero Business Development Language.\")\n   - The name of an [imported extension class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_section_extension_packages.html \"Several utility classes and functions are provided in additional packages.\")\n   - The name of an [imported Java class](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_JavaBridge_001.html \"The Java interface allows you to import Java classes and instantiate Java objects in your programs.\")\n7. record-name\n   is the name of a parameter defined with a record `TYPE`.\n8. record-type\n   is a the name of a user-defined [`TYPE`](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_user_types_001.html \"Types can be defined by the programmer to centralize the definition of complex\/structured variables.\") declared as a `RECORD` structure.\n9. local-declaration\n   is a `DEFINE`, `CONSTANT` or `TYPE` instruction.\n10. instruction\n    is a language statement to be executed when the method is invoked.\n11. expression\n    is a value to be returned by the method.\n\n## Function names\nLike other identifiers, function names are case-insensitive. However, always consider using the same naming convention when defining and invoking functions.\n\nIf the function name is also the name of a built-in function, an error occurs at link time, even if the program does not reference the built-in function.\n\n## Function definition using legacy syntax\nThe following example shows a function definition using the legacy syntax, with parameter definition in the function body:\n```\nFUNCTION split(str, len)\n    DEFINE str STRING, len INT\n    RETURN str.subString(1, len),\n           str.subString(len+1, str.getLength())\nEND FUNCTION\n```\n\nThis syntax does not define a function with a complete signature.\n\n## Function definition with complete function type\nBy specifying data types in the parameter list, you define a function with a complete function type.\n\nThis syntax allows better compilation checking:\n```\nFUNCTION split(str STRING, len INT) RETURNS (STRING, STRING)\n    RETURN str.subString(1, len),\n           str.subString(len+1, str.getLength())\nEND FUNCTION\n```\n\nBraces after the `RETURNS` clause are not required, when the function returns a single value:\n```\nFUNCTION count_items(sid INT) RETURNS INT\n    DEFINE cnt INT\n    SELECT COUNT(*) INTO cnt FROM stock WHERE stock_id = sid\n    RETURN cnt\nEND FUNCTION\n```\n\nWhen the function returns a single value\/type, it is also possible to enclose the type in parentheses:\n```\nFUNCTION count_items(sid INT) RETURNS (INT)\n    ...\n```\nIn the next example, the function has no parameters and does not return values:\n```\nFUNCTION clean_debug_log() RETURNS ()\n    CALL os.Path.delete(\"log.txt\")\nEND FUNCTION\n```\n\n## Methods\nA `FUNCTION` definition using a receiver identifier and type defines a method for this type. Specify the receiver identifier and type before the method name:\n```\nTYPE Rectangle RECORD\n    height, width DOUBLE PRECISION\nEND RECORD\n\nFUNCTION (r Rectangle) area() RETURNS DOUBLE PRECISION\n    RETURN r.height * r.width\nEND FUNCTION\n```\n\nFor more details see [Methods](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_methods.html \"A function declared with a receiver type defines a method for this type.\").\n\n## Function with record passed as reference\nThe `INOUT` keyword can be used to pass records by reference:\n```\nFUNCTION init_cust(r CustRec INOUT)\n    LET r.cust_id = 0\n    LET r.cust_name = \"<undefined>\"\n    LET r.cust_addr = \"<undefined>\"\n    LET r.cust_crea = CURRENT\nEND FUNCTION\n```\nFor more details see [Function parameters](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_parameters.html \"Functions can take parameters, to specialize their behavior.\").\n\n## Function with attributes\nFunction attributes can be used to complete the definition of the function itself, for its parameters and return values:\n```\nFUNCTION add(\n    p1 INTEGER ATTRIBUTES(json_name = \"parameter 1\"),\n    p2 INTEGER ATTRIBUTES(json_name = \"parameter 2\")\n    )\n    ATTRIBUTES(json_name = \"function add\")\n    RETURNS INTEGER ATTRIBUTES(json_name = \"return value 1\")\n        DEFINE var1 INTEGER\n        LET var1 = (p1 + p2)\n        RETURN var1\nEND FUNCTION\n```\nFunction attributes are especially useful to implement [RESTful Web Services functions](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_gws_restful.html \"With Genero Business Development Language, you can code a RESTful Web Services client or server application using low-level APIs.\").\n\nFor more details see [Function attributes](https:\/\/4js.com\/online_documentation\/fjs-fgl-manual-html\/fgl-topics\/c_fgl_Functions_attributes.html \"Function attributes can be used to add definition information about the function, its parameters and its return values.\").","meta_canonical":null}

3. Robots.txt Check

Query:

Response:

4. Spam/Ban Check

Query:

Response:

5. Seen Status Check

ℹ️ Skipped - page is already crawled

📄

INDEXABLE

✅

CRAWLED

5 days ago

🤖

ROBOTS ALLOWED

Page Info Filters

Filter	Status	Condition	Details
HTTP status	PASS	`download_http_code = 200`	HTTP 200
Age cutoff	PASS	`download_stamp > now() - 6 MONTH`	0.2 months ago
History drop	PASS	`isNull(history_drop_reason)`	No drop reason
Spam/ban	PASS	`fh_dont_index != 1 AND ml_spam_score = 0`	ml_spam_score=0
Canonical	PASS	`meta_canonical IS NULL OR = '' OR = src_unparsed`	Not set

Page Details

Property	Value
URL	https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_syntax.html
Last Crawled	2026-04-12 20:17:21 (5 days ago)
First Indexed	2018-11-19 17:36:38 (7 years ago)
HTTP Status Code	200
Meta Title	FUNCTION definitions
Meta Description	A FUNCTION definition defines a named procedure with a set of statements.
Meta Canonical	null
Boilerpipe Text	A FUNCTION definition defines a named procedure with a set of statements. Syntax 1 (legacy function syntax): [ PUBLIC \| PRIVATE ] FUNCTION function-name ( [ parameter-name [ , ...] ] ) [ DEFINE parameter-name type-specification [ , ...] ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [ , ...] ] [...] ] END FUNCTION function-name is the function identifier. parameter-name is the name of a formal argument of the function. type-specification can be one of: A primitive type A record definition An array definition A dictionary definition A function type definition The name of a user defined type The name of a built-in class The name of an imported extension class The name of an imported Java class local-declaration is a DEFINE , CONSTANT or TYPE instruction. instruction is a language statement to be executed when the function is invoked. expression is a value to be returned by the function. Syntax 2 (fully typed function): [ PUBLIC \| PRIVATE ] FUNCTION function-name ( { parameter-name type-specification [ attributes-list ] \| record-name record-type INOUT } [ , ...] ) [ attributes-list ] [ RETURNS returns-specification ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [ , ...] ] [...] ] END FUNCTION where returns-specification is: { type-specification [ attributes-list ] \| ( type-specification [ attributes-list ] [ , ...] ) \| ( ) } function-name is the identifier of the function, that must follow the convention for identifiers . parameter-name is the name of a formal argument of the function. type-specification can be one of: A primitive type A record definition An array definition A dictionary definition A function type definition The name of a user defined type The name of a built-in class The name of an imported extension class The name of an imported Java class record-name is the name of a parameter defined as record-type . record-type is a the name of a user-defined TYPE declared as a RECORD structure. attributes-list is a comma-separated list of name = value pairs or name attributes, and defines attributes for the function . local-declaration is a DEFINE , CONSTANT or TYPE instruction. instruction is a language statement to be executed when the function is invoked. expression is a value to be returned by the function. Syntax 3 (methods): [ PUBLIC \| PRIVATE ] FUNCTION ( receiver-name receiver-type ) method-name ( { parameter-name type-specification \| record-name record-type INOUT } [ , ...] ) [ RETURNS returns-specification ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [ , ...] ] [...] ] END FUNCTION where returns-specification is: { type-specification \| ( type-specification [ , ...] ) \| ( ) } A ( receiver-name receiver-type ) clause defines a function as a method for a user-defined type. receiver-name is the identifier of the receiver referenced in the method body. receiver-type is the user-defined type to be the target of this method. method-name is the identifier of the method. parameter-name is the name of a formal argument of the method. type-specification can be one of: A primitive type A record definition An array definition A dictionary definition A function type definition The name of a user defined type The name of a built-in class The name of an imported extension class The name of an imported Java class record-name is the name of a parameter defined with a record TYPE . record-type is a the name of a user-defined TYPE declared as a RECORD structure. local-declaration is a DEFINE , CONSTANT or TYPE instruction. instruction is a language statement to be executed when the method is invoked. expression is a value to be returned by the method. Function names Like other identifiers, function names are case-insensitive. However, always consider using the same naming convention when defining and invoking functions. If the function name is also the name of a built-in function, an error occurs at link time, even if the program does not reference the built-in function. Function definition using legacy syntax The following example shows a function definition using the legacy syntax, with parameter definition in the function body: FUNCTION split(str, len) DEFINE str STRING, len INT RETURN str.subString(1, len), str.subString(len+1, str.getLength()) END FUNCTION This syntax does not define a function with a complete signature. Function definition with complete function type By specifying data types in the parameter list, you define a function with a complete function type. This syntax allows better compilation checking: FUNCTION split(str STRING, len INT) RETURNS (STRING, STRING) RETURN str.subString(1, len), str.subString(len+1, str.getLength()) END FUNCTION Braces after the RETURNS clause are not required, when the function returns a single value: FUNCTION count_items(sid INT) RETURNS INT DEFINE cnt INT SELECT COUNT() INTO cnt FROM stock WHERE stock_id = sid RETURN cnt END FUNCTION When the function returns a single value/type, it is also possible to enclose the type in parentheses: FUNCTION count_items(sid INT) RETURNS (INT) ... In the next example, the function has no parameters and does not return values: FUNCTION clean_debug_log() RETURNS () CALL os.Path.delete("log.txt") END FUNCTION Methods A FUNCTION definition using a receiver identifier and type defines a method for this type. Specify the receiver identifier and type before the method name: TYPE Rectangle RECORD height, width DOUBLE PRECISION END RECORD FUNCTION (r Rectangle) area() RETURNS DOUBLE PRECISION RETURN r.height r.width END FUNCTION For more details see Methods . Function with record passed as reference The INOUT keyword can be used to pass records by reference: FUNCTION init_cust(r CustRec INOUT) LET r.cust_id = 0 LET r.cust_name = "<undefined>" LET r.cust_addr = "<undefined>" LET r.cust_crea = CURRENT END FUNCTION For more details see Function parameters . Function with attributes Function attributes can be used to complete the definition of the function itself, for its parameters and return values: FUNCTION add( p1 INTEGER ATTRIBUTES(json_name = "parameter 1"), p2 INTEGER ATTRIBUTES(json_name = "parameter 2") ) ATTRIBUTES(json_name = "function add") RETURNS INTEGER ATTRIBUTES(json_name = "return value 1") DEFINE var1 INTEGER LET var1 = (p1 + p2) RETURN var1 END FUNCTION Function attributes are especially useful to implement RESTful Web Services functions . For more details see Function attributes .
Markdown	\| \| \| \|---\|---\| \| [Language basics](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_language_basics.html "These topics cover the basics for the Genero Business Development Language (BDL)")[Functions](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_001.html "Describes user defined functions.") \| [Parent topic: Functions](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_001.html "Describes user defined functions.") \| # FUNCTION definitions A `FUNCTION` definition defines a named procedure with a set of statements. ## Syntax 1 (legacy function syntax): ``` [PUBLIC\|PRIVATE] FUNCTION function-name ( [ parameter-name [,...] ] ) [ DEFINE parameter-name type-specification [,...] ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [,...] ] [...] ] END FUNCTION ``` 1. function-name is the function identifier. 2. parameter-name is the name of a formal argument of the function. 3. type-specification can be one of: - A [primitive type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_variables_primitive_type.html "Type definitions using a primitive data type define a primitive type.") - A [record definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_records_002.html "The RECORD keyword defines a structured type or variable.") - An [array definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Arrays_002.html "An array defines a vector variable with a list of elements.") - A [dictionary definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Dictionary_syntax.html "A dictionary defines an associative array (hash-map) of elements.") - A [function type definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_references.html "Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.") - The name of a [user defined type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_003.html "Types define a synonym for a base or structured data type.") - The name of a [built-in class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_built_in_classes.html "These topics cover the built-in classes provided by the Genero Business Development Language.") - The name of an [imported extension class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_extension_packages.html "Several utility classes and functions are provided in additional packages.") - The name of an [imported Java class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_JavaBridge_001.html "The Java interface allows you to import Java classes and instantiate Java objects in your programs.") 4. local-declaration is a `DEFINE`, `CONSTANT` or `TYPE` instruction. 5. instruction is a language statement to be executed when the function is invoked. 6. expression is a value to be returned by the function. ## Syntax 2 (fully typed function): ``` [PUBLIC\|PRIVATE] FUNCTION function-name ( { parameter-name type-specification [ attributes-list ] \| record-name record-type INOUT } [,...] ) [ attributes-list ] [ RETURNS returns-specification ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [,...] ] [...] ] END FUNCTION ``` where returns-specification is: ``` { type-specification [ attributes-list ] \| ( type-specification [ attributes-list ] [,...] ) \| ( ) } ``` 1. function-name is the identifier of the function, that must follow the convention for [identifiers](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_language_features_identifiers.html "A Genero BDL identifier is a sequence of characters used to identify a program entity."). 2. parameter-name is the name of a formal argument of the function. 3. type-specification can be one of: - A [primitive type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_variables_primitive_type.html "Type definitions using a primitive data type define a primitive type.") - A [record definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_records_002.html "The RECORD keyword defines a structured type or variable.") - An [array definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Arrays_002.html "An array defines a vector variable with a list of elements.") - A [dictionary definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Dictionary_syntax.html "A dictionary defines an associative array (hash-map) of elements.") - A [function type definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_references.html "Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.") - The name of a [user defined type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_003.html "Types define a synonym for a base or structured data type.") - The name of a [built-in class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_built_in_classes.html "These topics cover the built-in classes provided by the Genero Business Development Language.") - The name of an [imported extension class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_extension_packages.html "Several utility classes and functions are provided in additional packages.") - The name of an [imported Java class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_JavaBridge_001.html "The Java interface allows you to import Java classes and instantiate Java objects in your programs.") 4. record-name is the name of a parameter defined as record-type . 5. record-type is a the name of a user-defined [`TYPE`](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_001.html "Types can be defined by the programmer to centralize the definition of complex/structured variables.") declared as a [`RECORD`](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_records_002.html "The RECORD keyword defines a structured type or variable.") structure. 6. attributes-list is a comma-separated list of name = value pairs or name attributes, and defines [attributes for the function](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_attributes.html "Function attributes can be used to add definition information about the function, its parameters and its return values."). 7. local-declaration is a `DEFINE`, `CONSTANT` or `TYPE` instruction. 8. instruction is a language statement to be executed when the function is invoked. 9. expression is a value to be returned by the function. ## Syntax 3 (methods): ``` [PUBLIC\|PRIVATE] FUNCTION ( receiver-name receiver-type ) method-name ( { parameter-name type-specification \| record-name record-type INOUT } [,...] ) [ RETURNS returns-specification ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [,...] ] [...] ] END FUNCTION ``` where returns-specification is: ``` { type-specification \| ( type-specification [,...] ) \| ( ) } ``` 1. A `(receiver-name receiver-type)` clause defines a function as a method for a user-defined type. 2. receiver-name is the identifier of the receiver referenced in the method body. 3. receiver-type is the user-defined type to be the target of this method. 4. method-name is the identifier of the method. 5. parameter-name is the name of a formal argument of the method. 6. type-specification can be one of: - A [primitive type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_variables_primitive_type.html "Type definitions using a primitive data type define a primitive type.") - A [record definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_records_002.html "The RECORD keyword defines a structured type or variable.") - An [array definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Arrays_002.html "An array defines a vector variable with a list of elements.") - A [dictionary definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Dictionary_syntax.html "A dictionary defines an associative array (hash-map) of elements.") - A [function type definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_references.html "Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.") - The name of a [user defined type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_003.html "Types define a synonym for a base or structured data type.") - The name of a [built-in class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_built_in_classes.html "These topics cover the built-in classes provided by the Genero Business Development Language.") - The name of an [imported extension class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_extension_packages.html "Several utility classes and functions are provided in additional packages.") - The name of an [imported Java class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_JavaBridge_001.html "The Java interface allows you to import Java classes and instantiate Java objects in your programs.") 7. record-name is the name of a parameter defined with a record `TYPE`. 8. record-type is a the name of a user-defined [`TYPE`](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_001.html "Types can be defined by the programmer to centralize the definition of complex/structured variables.") declared as a `RECORD` structure. 9. local-declaration is a `DEFINE`, `CONSTANT` or `TYPE` instruction. 10. instruction is a language statement to be executed when the method is invoked. 11. expression is a value to be returned by the method. ## Function names Like other identifiers, function names are case-insensitive. However, always consider using the same naming convention when defining and invoking functions. If the function name is also the name of a built-in function, an error occurs at link time, even if the program does not reference the built-in function. ## Function definition using legacy syntax The following example shows a function definition using the legacy syntax, with parameter definition in the function body: ``` FUNCTION split(str, len) DEFINE str STRING, len INT RETURN str.subString(1, len), str.subString(len+1, str.getLength()) END FUNCTION ``` This syntax does not define a function with a complete signature. ## Function definition with complete function type By specifying data types in the parameter list, you define a function with a complete function type. This syntax allows better compilation checking: ``` FUNCTION split(str STRING, len INT) RETURNS (STRING, STRING) RETURN str.subString(1, len), str.subString(len+1, str.getLength()) END FUNCTION ``` Braces after the `RETURNS` clause are not required, when the function returns a single value: ``` FUNCTION count_items(sid INT) RETURNS INT DEFINE cnt INT SELECT COUNT() INTO cnt FROM stock WHERE stock_id = sid RETURN cnt END FUNCTION ``` When the function returns a single value/type, it is also possible to enclose the type in parentheses: ``` FUNCTION count_items(sid INT) RETURNS (INT) ... ``` In the next example, the function has no parameters and does not return values: ``` FUNCTION clean_debug_log() RETURNS () CALL os.Path.delete("log.txt") END FUNCTION ``` ## Methods A `FUNCTION` definition using a receiver identifier and type defines a method for this type. Specify the receiver identifier and type before the method name: ``` TYPE Rectangle RECORD height, width DOUBLE PRECISION END RECORD FUNCTION (r Rectangle) area() RETURNS DOUBLE PRECISION RETURN r.height r.width END FUNCTION ``` For more details see [Methods](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_methods.html "A function declared with a receiver type defines a method for this type."). ## Function with record passed as reference The `INOUT` keyword can be used to pass records by reference: ``` FUNCTION init_cust(r CustRec INOUT) LET r.cust_id = 0 LET r.cust_name = "<undefined>" LET r.cust_addr = "<undefined>" LET r.cust_crea = CURRENT END FUNCTION ``` For more details see [Function parameters](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_parameters.html "Functions can take parameters, to specialize their behavior."). ## Function with attributes Function attributes can be used to complete the definition of the function itself, for its parameters and return values: ``` FUNCTION add( p1 INTEGER ATTRIBUTES(json_name = "parameter 1"), p2 INTEGER ATTRIBUTES(json_name = "parameter 2") ) ATTRIBUTES(json_name = "function add") RETURNS INTEGER ATTRIBUTES(json_name = "return value 1") DEFINE var1 INTEGER LET var1 = (p1 + p2) RETURN var1 END FUNCTION ``` Function attributes are especially useful to implement [RESTful Web Services functions](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_gws_restful.html "With Genero Business Development Language, you can code a RESTful Web Services client or server application using low-level APIs."). For more details see [Function attributes](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_attributes.html "Function attributes can be used to add definition information about the function, its parameters and its return values."). Related concepts [Variables](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_variables_001.html "Explains how to define program variables.") [Expressions](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Expressions_001.html "Shows the possible expressions supported in the language.") [Commenting a function](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_AutoDoc_007.html "Commenting a function") [Parent topic: Functions](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_001.html "Describes user defined functions.")
Readable Markdown	A `FUNCTION` definition defines a named procedure with a set of statements. ## Syntax 1 (legacy function syntax): ``` [PUBLIC\|PRIVATE] FUNCTION function-name ( [ parameter-name [,...] ] ) [ DEFINE parameter-name type-specification [,...] ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [,...] ] [...] ] END FUNCTION ``` 1. function-name is the function identifier. 2. parameter-name is the name of a formal argument of the function. 3. type-specification can be one of: - A [primitive type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_variables_primitive_type.html "Type definitions using a primitive data type define a primitive type.") - A [record definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_records_002.html "The RECORD keyword defines a structured type or variable.") - An [array definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Arrays_002.html "An array defines a vector variable with a list of elements.") - A [dictionary definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Dictionary_syntax.html "A dictionary defines an associative array (hash-map) of elements.") - A [function type definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_references.html "Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.") - The name of a [user defined type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_003.html "Types define a synonym for a base or structured data type.") - The name of a [built-in class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_built_in_classes.html "These topics cover the built-in classes provided by the Genero Business Development Language.") - The name of an [imported extension class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_extension_packages.html "Several utility classes and functions are provided in additional packages.") - The name of an [imported Java class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_JavaBridge_001.html "The Java interface allows you to import Java classes and instantiate Java objects in your programs.") 4. local-declaration is a `DEFINE`, `CONSTANT` or `TYPE` instruction. 5. instruction is a language statement to be executed when the function is invoked. 6. expression is a value to be returned by the function. ## Syntax 2 (fully typed function): ``` [PUBLIC\|PRIVATE] FUNCTION function-name ( { parameter-name type-specification [ attributes-list ] \| record-name record-type INOUT } [,...] ) [ attributes-list ] [ RETURNS returns-specification ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [,...] ] [...] ] END FUNCTION ``` where returns-specification is: ``` { type-specification [ attributes-list ] \| ( type-specification [ attributes-list ] [,...] ) \| ( ) } ``` 1. function-name is the identifier of the function, that must follow the convention for [identifiers](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_language_features_identifiers.html "A Genero BDL identifier is a sequence of characters used to identify a program entity."). 2. parameter-name is the name of a formal argument of the function. 3. type-specification can be one of: - A [primitive type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_variables_primitive_type.html "Type definitions using a primitive data type define a primitive type.") - A [record definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_records_002.html "The RECORD keyword defines a structured type or variable.") - An [array definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Arrays_002.html "An array defines a vector variable with a list of elements.") - A [dictionary definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Dictionary_syntax.html "A dictionary defines an associative array (hash-map) of elements.") - A [function type definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_references.html "Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.") - The name of a [user defined type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_003.html "Types define a synonym for a base or structured data type.") - The name of a [built-in class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_built_in_classes.html "These topics cover the built-in classes provided by the Genero Business Development Language.") - The name of an [imported extension class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_extension_packages.html "Several utility classes and functions are provided in additional packages.") - The name of an [imported Java class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_JavaBridge_001.html "The Java interface allows you to import Java classes and instantiate Java objects in your programs.") 4. record-name is the name of a parameter defined as record-type . 5. record-type is a the name of a user-defined [`TYPE`](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_001.html "Types can be defined by the programmer to centralize the definition of complex/structured variables.") declared as a [`RECORD`](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_records_002.html "The RECORD keyword defines a structured type or variable.") structure. 6. attributes-list is a comma-separated list of name = value pairs or name attributes, and defines [attributes for the function](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_attributes.html "Function attributes can be used to add definition information about the function, its parameters and its return values."). 7. local-declaration is a `DEFINE`, `CONSTANT` or `TYPE` instruction. 8. instruction is a language statement to be executed when the function is invoked. 9. expression is a value to be returned by the function. ## Syntax 3 (methods): ``` [PUBLIC\|PRIVATE] FUNCTION ( receiver-name receiver-type ) method-name ( { parameter-name type-specification \| record-name record-type INOUT } [,...] ) [ RETURNS returns-specification ] [ local-declaration [...] ] [ instruction \| [ RETURN expression [,...] ] [...] ] END FUNCTION ``` where returns-specification is: ``` { type-specification \| ( type-specification [,...] ) \| ( ) } ``` 1. A `(receiver-name receiver-type)` clause defines a function as a method for a user-defined type. 2. receiver-name is the identifier of the receiver referenced in the method body. 3. receiver-type is the user-defined type to be the target of this method. 4. method-name is the identifier of the method. 5. parameter-name is the name of a formal argument of the method. 6. type-specification can be one of: - A [primitive type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_variables_primitive_type.html "Type definitions using a primitive data type define a primitive type.") - A [record definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_records_002.html "The RECORD keyword defines a structured type or variable.") - An [array definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Arrays_002.html "An array defines a vector variable with a list of elements.") - A [dictionary definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Dictionary_syntax.html "A dictionary defines an associative array (hash-map) of elements.") - A [function type definition](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_references.html "Function can be referenced and invoked dynamically in a CALL instruction, or in an expression.") - The name of a [user defined type](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_003.html "Types define a synonym for a base or structured data type.") - The name of a [built-in class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_built_in_classes.html "These topics cover the built-in classes provided by the Genero Business Development Language.") - The name of an [imported extension class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_section_extension_packages.html "Several utility classes and functions are provided in additional packages.") - The name of an [imported Java class](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_JavaBridge_001.html "The Java interface allows you to import Java classes and instantiate Java objects in your programs.") 7. record-name is the name of a parameter defined with a record `TYPE`. 8. record-type is a the name of a user-defined [`TYPE`](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_user_types_001.html "Types can be defined by the programmer to centralize the definition of complex/structured variables.") declared as a `RECORD` structure. 9. local-declaration is a `DEFINE`, `CONSTANT` or `TYPE` instruction. 10. instruction is a language statement to be executed when the method is invoked. 11. expression is a value to be returned by the method. ## Function names Like other identifiers, function names are case-insensitive. However, always consider using the same naming convention when defining and invoking functions. If the function name is also the name of a built-in function, an error occurs at link time, even if the program does not reference the built-in function. ## Function definition using legacy syntax The following example shows a function definition using the legacy syntax, with parameter definition in the function body: ``` FUNCTION split(str, len) DEFINE str STRING, len INT RETURN str.subString(1, len), str.subString(len+1, str.getLength()) END FUNCTION ``` This syntax does not define a function with a complete signature. ## Function definition with complete function type By specifying data types in the parameter list, you define a function with a complete function type. This syntax allows better compilation checking: ``` FUNCTION split(str STRING, len INT) RETURNS (STRING, STRING) RETURN str.subString(1, len), str.subString(len+1, str.getLength()) END FUNCTION ``` Braces after the `RETURNS` clause are not required, when the function returns a single value: ``` FUNCTION count_items(sid INT) RETURNS INT DEFINE cnt INT SELECT COUNT() INTO cnt FROM stock WHERE stock_id = sid RETURN cnt END FUNCTION ``` When the function returns a single value/type, it is also possible to enclose the type in parentheses: ``` FUNCTION count_items(sid INT) RETURNS (INT) ... ``` In the next example, the function has no parameters and does not return values: ``` FUNCTION clean_debug_log() RETURNS () CALL os.Path.delete("log.txt") END FUNCTION ``` ## Methods A `FUNCTION` definition using a receiver identifier and type defines a method for this type. Specify the receiver identifier and type before the method name: ``` TYPE Rectangle RECORD height, width DOUBLE PRECISION END RECORD FUNCTION (r Rectangle) area() RETURNS DOUBLE PRECISION RETURN r.height r.width END FUNCTION ``` For more details see [Methods](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_methods.html "A function declared with a receiver type defines a method for this type."). ## Function with record passed as reference The `INOUT` keyword can be used to pass records by reference: ``` FUNCTION init_cust(r CustRec INOUT) LET r.cust_id = 0 LET r.cust_name = "<undefined>" LET r.cust_addr = "<undefined>" LET r.cust_crea = CURRENT END FUNCTION ``` For more details see [Function parameters](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_parameters.html "Functions can take parameters, to specialize their behavior."). ## Function with attributes Function attributes can be used to complete the definition of the function itself, for its parameters and return values: ``` FUNCTION add( p1 INTEGER ATTRIBUTES(json_name = "parameter 1"), p2 INTEGER ATTRIBUTES(json_name = "parameter 2") ) ATTRIBUTES(json_name = "function add") RETURNS INTEGER ATTRIBUTES(json_name = "return value 1") DEFINE var1 INTEGER LET var1 = (p1 + p2) RETURN var1 END FUNCTION ``` Function attributes are especially useful to implement [RESTful Web Services functions](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_gws_restful.html "With Genero Business Development Language, you can code a RESTful Web Services client or server application using low-level APIs."). For more details see [Function attributes](https://4js.com/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_attributes.html "Function attributes can be used to add definition information about the function, its parameters and its return values.").
Shard	199 (laksa)
Root Hash	14951230760913715399
Unparsed URL	com,4js!/online_documentation/fjs-fgl-manual-html/fgl-topics/c_fgl_Functions_syntax.html s443