Spec-Zone.ru › ColdFusion

cfhttpparam

Разрешён только внутри тела тега cfhttp. Обязателен для операций POST тега cfhttp. Для всех остальных операций необязателен. Задаёт параметры для формирования HTTP-запроса.

<cfhttpparam type="header">

cfhttpparam(type="header");

  • CF4+
  • Lucee
  • BL 1.0.0+
  • См. также: cfhttp

    Справочник по атрибутам

    type string
    Обязательный

    Тип отправляемых данных header: Задаёт HTTP-заголовок. Значение не кодируется для URLbody: Указывает, что value является телом HTTP-запроса.xml: Идентифицирует запрос как имеющий тип содержимого text/xml и указывает, что атрибут value содержит тело HTTP-запроса.cgi: То же, что и header, но по умолчанию выполняет кодирование value для URL.file: Указывает CFML отправить содержимое указанного файла.url: Задаёт пару имя-значение строки запроса URL для добавления к атрибуту url тега cfhttp. Значение кодируется для URL.formfield: Задаёт отправляемое поле формы. По умолчанию значение кодируется для URL.cookie: Задаёт cookie, отправляемый как HTTP-заголовок. Значение кодируется для URL.
    Значения:
    • header
    • body
    • xml
    • cgi
    • file
    • url
    • formfield
    • cookie

    name string

    Имя переменной для передаваемых данных. Игнорируется для типов body и xml. Для типа file задаёт имя файла.

    value string

    Значение отправляемых данных. Игнорируется для типа file. Для всех атрибутов type, кроме Body, значение должно содержать строковые данные или данные, которые CFML может преобразовать в строку. Для типов Body допускаются строковые или двоичные значения.

    file string

    Применяется к типу file; для всех остальных типов игнорируется. Абсолютный путь к файлу, который отправляется вместе с запросом.

    encoded boolean

    Применяется к типам formfield и cgi; для всех остальных типов игнорируется. Указывает, нужно ли кодировать поле формы или заголовок с помощью URLEncode.
    Значения:
    • true
    • false

    mimetype string

    Применяется к типу file; для всех остальных типов недопустим. Задаёт тип MIME для содержимого файла. Тип содержимого может включать идентификатор кодировки символов файла; например, text/html; charset=ISO-8859-1 указывает, что файл содержит текст HTML в кодировке символов ISO Latin-1.
    Значения:
    • text/plain
    • text/html

    Совместимость

    BoxLang:

    Версия 1.0.0+ , <bx:httpparam>` в BoxLang

    Примеры
    Пример кода с использованием тега cfhttpparam

    Синтаксис скрипта (CF11+)

    cfhttp(method="POST", charset="utf-8", url="https://www.google.com/", result="result") {
        cfhttpparam(name="q", type="formfield", value="cfml");
    }
    writeDump(result);

    Альтернативный синтаксис скрипта (CF9+). Удалён в ColdFusion 2025.

    httpService = new http(method = "POST", charset = "utf-8", url = "https://www.google.com/");
    httpService.addParam(name = "q", type = "formfield", value = "cfml");
    result = httpService.send().getPrefix();
    writeDump(result);

    Синтаксис тега CFHTTP

    <cfhttp result="result" method="POST" charset="utf-8" url="https://www.google.com/">
        <cfhttpparam name="q" type="formfield" value="cfml">
    </cfhttp>
    <cfdump var="#result#">

    © 2012–present Foundeo, Inc. and the CFDocs contributors.
    Licensed under the MIT License.
    ColdFusion is a trademark of Adobe Systems Incorporated.
    https://cfdocs.org/cfhttpparam

    Spec-Zone.ru

    Настройки Оффлайн Что нового Помощь О нас
    Spec-Zone .ru
    спецификации, руководства, описания, API