Поделиться через

перечисление WS_MESSAGE_PROPERTY_ID (webservices.h)

  • Статья

Каждое свойство сообщения имеет тип WS_MESSAGE_PROPERTY, определяется идентификатором и имеет связанное значение.

Синтаксис

typedef enum {
  WS_MESSAGE_PROPERTY_STATE = 0,
  WS_MESSAGE_PROPERTY_HEAP = 1,
  WS_MESSAGE_PROPERTY_ENVELOPE_VERSION = 2,
  WS_MESSAGE_PROPERTY_ADDRESSING_VERSION = 3,
  WS_MESSAGE_PROPERTY_HEADER_BUFFER = 4,
  WS_MESSAGE_PROPERTY_HEADER_POSITION = 5,
  WS_MESSAGE_PROPERTY_BODY_READER = 6,
  WS_MESSAGE_PROPERTY_BODY_WRITER = 7,
  WS_MESSAGE_PROPERTY_IS_ADDRESSED = 8,
  WS_MESSAGE_PROPERTY_HEAP_PROPERTIES = 9,
  WS_MESSAGE_PROPERTY_XML_READER_PROPERTIES = 10,
  WS_MESSAGE_PROPERTY_XML_WRITER_PROPERTIES = 11,
  WS_MESSAGE_PROPERTY_IS_FAULT = 12,
  WS_MESSAGE_PROPERTY_MAX_PROCESSED_HEADERS = 13,
  WS_MESSAGE_PROPERTY_USERNAME = 14,
  WS_MESSAGE_PROPERTY_ENCODED_CERT = 15,
  WS_MESSAGE_PROPERTY_TRANSPORT_SECURITY_WINDOWS_TOKEN = 16,
  WS_MESSAGE_PROPERTY_HTTP_HEADER_AUTH_WINDOWS_TOKEN = 17,
  WS_MESSAGE_PROPERTY_MESSAGE_SECURITY_WINDOWS_TOKEN = 18,
  WS_MESSAGE_PROPERTY_SAML_ASSERTION = 19,
  WS_MESSAGE_PROPERTY_SECURITY_CONTEXT = 20,
  WS_MESSAGE_PROPERTY_PROTECTION_LEVEL = 21
} WS_MESSAGE_PROPERTY_ID;

Константы

 
WS_MESSAGE_PROPERTY_STATE
Значение: 0
Это свойство используется с WsGetMessageProperty.


Элемент сопутствующего значения структуры WS_MESSAGE_PROPERTY является текущим WS_MESSAGE_STATE сообщения.

Это свойство доступно во всех состояниях сообщений.
WS_MESSAGE_PROPERTY_HEAP
Значение: 1
Это свойство используется с WsGetMessageProperty.


Элемент сопутствующего значения структуры WS_MESSAGE_PROPERTY является WS_HEAP сообщения. Куча имеет значение
принадлежит сообщению. Пользователь сообщения может сделать дополнительное
выделение в этой куче. Выделение в куче освобождается
при сбросе или освобождении сообщения.


Пользователь возвращенной кучи не должен вызывать WsResetHeap в куче. Это приведет к неопределенному поведению.


Объект message не будет использовать объект кучи, если только не один из
вызываются API-интерфейсы сообщений.


Это свойство доступно во всех состояниях сообщений, кроме WS_MESSAGE_STATE_EMPTY.
Использование кучи пустого сообщения приведет к неопределенному поведению.
WS_MESSAGE_PROPERTY_ENVELOPE_VERSION
Значение: 2
Это свойство используется с WsGetMessageProperty.


Элемент сопутствующего значения структуры WS_MESSAGE_PROPERTY является WS_ENVELOPE_VERSION сообщения.


При создании сообщения с помощью WsCreateMessage
Версия конверта указывается в качестве явного параметра (вместо этого
в качестве свойства).


Это свойство может быть указано при указании свойств сообщения с помощью
структура WS_MESSAGE_PROPERTIES .


Это свойство доступно во всех состояниях сообщений, кроме WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_ADDRESSING_VERSION
Значение: 3
Это свойство используется с WsGetMessageProperty.


Элемент сопутствующего значения структуры WS_MESSAGE_PROPERTY является WS_ADDRESSING_VERSION сообщения.


При создании сообщения с помощью WsCreateMessage
версия адресации указывается в качестве явного параметра (вместо этого
в качестве свойства).


Это свойство может быть указано при указании свойств сообщения с помощью
структура WS_MESSAGE_PROPERTIES .


Это свойство доступно во всех состояниях сообщений, кроме WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_HEADER_BUFFER
Значение: 4
Это свойство используется с WsGetMessageProperty.


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY — это WS_XML_BUFFER , содержащий заголовки
сообщения (а также элементов конверта и основного текста).


Этот буфер действителен до тех пор, пока сообщение не будет сброшено или освобождено.


Это свойство доступно во всех состояниях сообщений, кроме WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_HEADER_POSITION
Значение: 5
Это свойство используется с WsGetMessageProperty.

Элемент сопутствующего значения структуры WS_MESSAGE_PROPERTY является WS_XML_NODE_POSITION элемента заголовка в буфере заголовков (элемент, содержащий все
заголовки сообщений в виде дочерних элементов). Сам буфер заголовков может быть
получено с помощью WS_MESSAGE_PROPERTY_HEADER_BUFFER.


Приложение может использовать WS_XML_NODE_POSITION , возвращенную в качестве запуска
точка при чтении или записи заголовков вручную (если не используется WsSetHeader,
WsGetHeader, WsGetCustomHeader или WsAddCustomHeader).
Например, позицию можно передать в WsSetWriterPosition или
WsSetReaderPosition для размещения средства чтения XML или модуля записи XML в WS_XML_BUFFER , содержащей заголовки. Дополнительно,
WsMoveReader или WsMoveWriter можно использовать для перемещения относительного
в положение, которое было задано.


При чтении заголовков сообщения (с помощью WsReadMessageStart или
WsReadEnvelopeStart, элемент заголовка автоматически добавляется в
буфер заголовка, если он отсутствует в считываемом сообщении. При инициализации сообщения
(через WsInitializeMessage) элемент заголовка добавляется автоматически.
в сообщение.


Это свойство доступно во всех состояниях сообщений, кроме WS_MESSAGE_STATE_EMPTY.


Позиция заголовка действительна до тех пор, пока сообщение не будет сброшено или освобождено.
WS_MESSAGE_PROPERTY_BODY_READER
Значение: 6
Это свойство используется с WsGetMessageProperty.


Элемент сопутствующего значения структуры WS_MESSAGE_PROPERTY является WS_XML_READER , который можно использовать для чтения
текст сообщения.


Средство чтения принадлежит объекту сообщения и является допустимым только
до вызова WsFreeMessage или WsResetMessage .


Это свойство доступно только в том случае, если сообщение имеет значение
в WS_MESSAGE_STATE_READING состоянии.
WS_MESSAGE_PROPERTY_BODY_WRITER
Значение: 7
Это свойство используется с WsGetMessageProperty.


Сопутствующий элемент значения структуры WS_MESSAGE_PROPERTY является WS_XML_WRITER , который можно использовать для записи
текст сообщения.


Это свойство доступно только в том случае, если сообщение находится в
состояние WS_MESSAGE_STATE_WRITING .


Модуль записи принадлежит объекту message и является допустимым только
до вызова WsFreeMessage или WsResetMessage .
WS_MESSAGE_PROPERTY_IS_ADDRESSED
Значение: 8
Это свойство используется с WsGetMessageProperty.


Элемент сопутствующего значения структуры WS_MESSAGE_PROPERTY является логическим значением, указывающим, есть ли в сообщении
были устранены.


При создании или сбросе сообщения это свойство имеет значение
для задано значение FALSE.


При чтении сообщения (WsReadMessageStart или
WsReadEnvelopeStart, то это свойство имеет значение
для свойства задано значение TRUE.


Это свойство доступно во всех состояниях сообщений, кроме WS_MESSAGE_STATE_EMPTY.


Дополнительные сведения см. в разделе WsAddressMessage .
WS_MESSAGE_PROPERTY_HEAP_PROPERTIES
Значение: 9
Это свойство используется с WsCreateMessage для указания свойств
WS_HEAP, связанного с сообщением.


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY имеет тип WS_HEAP_PROPERTIES.


Куча используется для буферизации заголовков сообщения.


Можно указать следующие свойства кучи:
WS_MESSAGE_PROPERTY_XML_READER_PROPERTIES
Значение: 10
Это свойство используется с WsCreateMessage для указания свойств.
относятся к средствам чтения XML , которые используются с сообщением.


Эти свойства средства чтения XML используются объектом message при чтении заголовков.
Кроме того, каналы используют эти свойства для модулей чтения, создаваемых ими для чтения.
Сообщения.


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY имеет тип WS_XML_READER_PROPERTIES.


Можно указать следующие свойства:
WS_MESSAGE_PROPERTY_XML_WRITER_PROPERTIES
Значение: 11
Это свойство используется с WsCreateMessage для указания свойств
средства записи XML , которые используются с сообщением.


Эти свойства модуля записи XML используются объектом message при записи заголовков.
Кроме того, каналы используют эти свойства для модулей записи, создаваемых ими.
Сообщения.


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY имеет тип WS_XML_WRITER_PROPERTIES.


Можно указать следующие свойства:
WS_MESSAGE_PROPERTY_IS_FAULT
Значение: 12
Это свойство используется с WsGetMessageProperty или WsSetMessageProperty , чтобы указать, содержит ли сообщение ошибку.


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY является логическим значением.

При чтении сообщения (WsReadMessageStart или WsReadEnvelopeStart),
Это свойство задается в зависимости от того, является ли первый элемент тела ошибкой
. Приложение может протестировать это свойство в качестве способа принятия решения о том,
значение , чтобы считать текст как ошибку. Чтобы считать текст как ошибку, используйте WsReadBody.
с WS_FAULT_TYPE для получения WS_FAULT.


При записи сообщения (WsWriteMessageStart или WsWriteEnvelopeStart)
Это свойство можно использовать для указания того, будет ли приложение записывать ошибку
в теле. Некоторые каналы будут использовать эту информацию, чтобы определить, как
отправить сообщение. Например, HTTP отправит код состояния 500 для ошибок вместо 200.


При инициализации сообщения с помощью WsInitializeMessage с
WS_FAULT_MESSAGE свойству присваивается значение TRUE.
Для других WS_MESSAGE_INITIALIZATION значений свойство имеет значение FALSE.


Это свойство доступно во всех состояниях сообщений, кроме WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_MAX_PROCESSED_HEADERS
Значение: 13
Это свойство используется с WsCreateMessage для указания максимального количества заголовков.
значение , которое будет разрешено при обработке заголовков сообщений.


Сопроводим элементом значенияструктуры WS_MESSAGE_PROPERTY является ULONG.

Цель этого ограничения — поставить верхнюю границу на число итераций.
провел сканирование заголовка.


Так как приложение может напрямую изменять содержимое буфера заголовков,
Это ограничение применяется не во всех случаях. Он применяется только в том случае, если один из
используются API доступа к заголовкам (WsSetHeader, WsGetHeader,
WsGetCustomHeader или WsGetMappedHeader).


Значение по умолчанию — 64.
WS_MESSAGE_PROPERTY_USERNAME
Значение: 14
Это свойство используется с WsGetMessageProperty для получения отправителя
имя пользователя из полученного сообщения, если безопасность на основе имени пользователя или пароля
параметр включен или значение , если для пользовательского канала задано значение .


Сопутствующий элемент значения структуры WS_MESSAGE_PROPERTY является WS_STRING структурой.

Возвращаемое значение будет хорошим, пока сообщение не будет освобождено или не сброшено.


Настраиваемый канал может использовать WsSetMessageProperty для задания
имя пользователя отправителя из сообщения, если оно поддерживает имя пользователя и пароль;
безопасность на основе. Функция создаст копию указанного значения.


Это свойство доступно во всех состояниях сообщений, кроме
WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_ENCODED_CERT
Значение: 15
Это свойство используется с WsGetMessageProperty для получения отправителя
сертификат из полученного сообщения в виде закодированных байтов, если
включен режим безопасности на основе сертификата (например, SSL);
или значение , если для настраиваемого канала задано значение .


Сопровождающий элемент значенияструктуры WS_MESSAGE_PROPERTY является WS_BYTES структурой.

Возвращаемое значение будет хорошим, пока сообщение не будет освобождено или не сброшено.


Настраиваемый канал может использовать WsSetMessageProperty для задания
сертификат отправителя из полученного сообщения, если он поддерживает
режим безопасности на основе сертификата. Функция создаст копию указанного значения.


Это свойство доступно во всех состояниях сообщений, кроме
WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_TRANSPORT_SECURITY_WINDOWS_TOKEN
Значение: 16
Это свойство используется с WsGetMessageProperty для получения Windows
маркер, представляющий отправителя из полученного сообщения. Это свойство имеет значение
доступно в следующих случаях:


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY является HANDLE.



  • WS_TCP_SSPI_TRANSPORT_SECURITY_BINDING используется.


  • WS_SSL_TRANSPORT_SECURITY_BINDING используется
    и преобразование сертификата клиента в токен Windows
    включен на уровне конфигурации http.sys.

  • Для реализации настраиваемого канала задано значение .


Возвращаемое значение будет хорошим, пока сообщение не будет освобождено или не сброшено.


Настраиваемый канал может использовать WsSetMessageProperty для задания
сертификат отправителя из полученного сообщения, если он поддерживает
режим безопасности на основе сертификата. Функция дублирует указанный дескриптор.


Это свойство доступно во всех состояниях сообщений, кроме
WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_HTTP_HEADER_AUTH_WINDOWS_TOKEN
Значение: 17
Это свойство используется с WsGetMessageProperty для получения Windows
маркер, представляющий отправителя из полученного сообщения, если
WS_HTTP_HEADER_AUTH_SECURITY_BINDING используется,
или значение , если для настраиваемого канала задано значение .


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY является HANDLE.

Возвращаемое значение будет хорошим, пока сообщение не будет освобождено или не сброшено.


Настраиваемый канал может использовать WsSetMessageProperty для задания
маркер Windows, представляющий отправителя из полученного сообщения.
Функция дублирует указанный дескриптор.


Это свойство доступно во всех состояниях сообщений, кроме
WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_MESSAGE_SECURITY_WINDOWS_TOKEN
Значение: 18
Это свойство используется с WsGetMessageProperty для получения Windows
маркер, представляющий отправителя из полученного сообщения, если сообщение является безопасностью
используется такая привязка, как WS_KERBEROS_APREQ_MESSAGE_SECURITY_BINDING ;
или значение , если для настраиваемого канала задано значение .


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY является HANDLE.

Возвращаемое значение будет хорошим, пока сообщение не будет освобождено или не сброшено.


Настраиваемый канал может использовать WsSetMessageProperty для задания
маркер, представляющий отправителя из полученного сообщения.
Функция дублирует указанный дескриптор.


Это свойство доступно во всех состояниях сообщений, кроме
WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_SAML_ASSERTION
Значение: 19
Это свойство используется с WsGetMessageProperty для получения утверждения SAML.
представляет отправителя из полученного сообщения, если
WS_SAML_MESSAGE_SECURITY_BINDING используется на стороне сервера,
или значение , если для настраиваемого канала задано значение .


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY является WS_XML_BUFFER.

Возвращаемое значение будет хорошим, пока сообщение не будет освобождено или не сброшено.


Настраиваемый канал может использовать WsSetMessageProperty для задания
утверждение SAML, представляющее отправителя из полученного сообщения.
Функция будет дублировать указанный буфер.


Это свойство доступно во всех состояниях сообщений, кроме
WS_MESSAGE_STATE_EMPTY.
WS_MESSAGE_PROPERTY_SECURITY_CONTEXT
Значение: 20
Это свойство используется с WsGetMessageProperty для получения дескриптора безопасного диалога, если
WS_SECURITY_CONTEXT_MESSAGE_SECURITY_BINDING используется на стороне сервера.


Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY является WS_SECURITY_CONTEXT.

Возвращаемое значение будет хорошим, пока сообщение не будет освобождено или не сброшено.
WS_MESSAGE_PROPERTY_PROTECTION_LEVEL
Значение: 21
Это свойство используется с WsGetMessageProperty для получения уровня безопасности сообщения.

Сопровождающий элемент значения структуры WS_MESSAGE_PROPERTY является WS_PROTECTION_LEVEL значением.

Если канал не использует безопасность или проверка безопасности не пройдена, для уровня защиты устанавливается значение
WS_PROTECTION_LEVEL_NONE. В противном случае ему присваивается уровень, запрошенный приложением.


Это свойство может использоваться для определения состояния проверки безопасности при WS_CHANNEL_PROPERTY_ALLOW_UNSECURED_FAULTS
для задано значение FALSE.


Настраиваемый канал может использовать WsSetMessageProperty для задания
уровень защиты полученного сообщения.


Это свойство доступно во всех состояниях сообщений, кроме
WS_MESSAGE_STATE_EMPTY.

Требования

Требование Значение
Минимальная версия клиента Windows 7 [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 R2 [классические приложения | Приложения UWP]
Верхняя часть webservices.h