{
  "synLogic": "int $ret \u003d $api($1, $2);",
  "help": "The ns_get_ua_string API returns the user agent string used in load test",
  "notes": "",
  "returns": "The ns_get_ua_string() API returns an integer value that indicates whether the user agent string was successfully obtained or not. A value of zero indicates that the user agent string was successfully obtained, while a value of -1 indicates an error.",
  "arguments": "\u003ctable class\u003d\"newGuiTable\" style\u003d\"width:100%\" \u003e  \u003ctr\u003e \u003cth\u003e Argument \u003c/th\u003e \u003cth\u003e Description \u003c/th\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e User Agent Buffer \u003c/td\u003e \u003ctd\u003e It is a character buffer that will contain the user agent string returned by the API. The size of this buffer must be at least User Agent Buffer Length bytes. \u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e User Agent Buffer Length \u003c/td\u003e \u003ctd\u003e It is an integer that specifies the maximum length of the user agent string that can be returned by the API. The value of this argument should be the size of the buffer passed in User Agent Buffer. \u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e",
  "parameterization": "",
  "component": [
    {
      "id": "$1",
      "type": "TEXT_VAR",
      "label": "User Agent Buffer",
      "value": "",
      "css": "p-grid p-align-center w-100-p",
      "title": "Enter User Agent Input Buffer",
      "placeHolder": "",
      "style": "",
      "isDisabled": "",
      "labelVarCheckbox": "If user agent buffer is a program variable.",
      "argIndex": 0,
      "validate": {
        "inputType": "Text",
        "required": true
      }
    },
    {
      "id": "$2",
      "type": "TextField",
      "label": "User Agent Buffer Length",
      "value": "",
      "css": "p-grid p-align-center w-100-p",
      "title": "Enter User Agent Buffer length",
      "placeHolder": "",
      "style": "",
      "isDisabled": "",
      "labelVarCheckbox": "",
      "argIndex": 0,
      "validate": {
        "inputType": "Number",
        "disabled": false,
        "required": true,
        "min": 0,
        "max": 2147483647
      },
      "quotes": true
    },
    {
      "id": "$ret",
      "type": "TextField",
      "label": "Return Variable",
      "value": "",
      "css": "p-grid p-align-center w-100-p",
      "title": "First character must be Alpha.\r\nOther characters are Alpha, Numeric or Underscore",
      "placeHolder": "",
      "style": "",
      "isDisabled": "",
      "labelVarCheckbox": "",
      "argIndex": 0,
      "validate": {
        "inputType": "Text",
        "disabled": false,
        "pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,63}$",
        "required": false,
        "min": 0,
        "max": 0,
        "method": "isValidVar(arg)"
      },
      "quotes": true
    }
  ],
  "name": "ns_get_ua_string",
  "syntax": "int ns_get_ua_string (char *ua_string_buf, int ua_string_len)",
  "javaSyntax": "",
  "cEx": "flow()\n{\n  char *uaStr \u003d ns_get_ua_string ();\n  printf(“%s”,uaStr);\n}",
  "javaEx": "",
  "insertStrC": "(char *ua_string_buf, int ua_string_len);",
  "insertStrJava": "",
  "description": "The ns_get_ua_string API returns the user agent string used in load test"
}