WsGetCustomHeader 함수(webservices.h)

메시지의 애플리케이션 정의 헤더를 찾아 역직렬화합니다.

구문

HRESULT WsGetCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *customHeaderDescription,
  [in]           WS_REPEATING_HEADER_OPTION   repeatingOption,
  [in]           ULONG                        headerIndex,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
                 ULONG                        *headerAttributes,
  [in, optional] WS_ERROR                     *error
);

매개 변수

[in] message

헤더를 포함하는 메시지입니다.

메시지는 모든 상태일 수 있지만 WS_MESSAGE_STATE_EMPTY.

[in] customHeaderDescription

헤더 요소를 설명하는 WS_ELEMENT_DESCRIPTION .

[in] repeatingOption

헤더가 메시지에 두 번 이상 나타날 수 있는지 여부입니다.

WS_REPEATING_HEADER 사용하는 경우 헤더 인덱스는 반환할 지정된 headerName이 있는 헤더 중 어느 것을 나타내는지 나타냅니다.

WS_SINGLETON_HEADER 사용하는 경우 headerIndex는 0이어야 합니다.

[in] headerIndex

지정된 headerName이 있는 헤더 집합 내의 헤더 인덱스(0부터 시작하는 인덱스)입니다.

[in] readOption

값이 필요한지 여부 및 값을 할당하는 방법입니다. 자세한 내용은 WS_READ_OPTION 참조하세요.

[in, optional] heap

역직렬화된 헤더 데이터를 저장할 힙입니다. NULL인 경우 메시지 힙은 WS_READ_OPTION 필요에 따라 사용됩니다.

value

이 매개 변수의 해석은 WS_READ_OPTION 따라 달라집니다.

[in] valueSize

이 매개 변수의 해석은 WS_READ_OPTION 따라 달라집니다.

headerAttributes

이 헤더의 WS_HEADER_ATTRIBUTES 반환합니다. 포인터는 NULL일 수 있으며 이 경우 특성이 반환되지 않습니다.

[in, optional] error

함수가 실패할 경우 추가 오류 정보를 저장할 위치를 지정합니다.

반환 값

이 함수는 이러한 값 중 하나를 반환할 수 있습니다.

반환 코드 설명
WS_E_INVALID_FORMAT
헤더가 없으므로 필수입니다.

WS_SINGLETON_HEADER 지정되었으며 메시지에 헤더 유형의 여러 인스턴스가 있습니다.

입력 데이터가 예상 형식이 아니었습니다.

WS_E_QUOTA_EXCEEDED
힙의 크기 할당량을 초과했습니다.
E_OUTOFMEMORY
헤더를 역직렬화하는 데 사용할 수 있는 메모리가 부족했습니다.
E_INVALIDARG
하나 이상의 매개 변수가 잘못되었습니다.
기타 오류
이 함수는 위에 나열되지 않은 다른 오류를 반환할 수 있습니다.

설명

이 API는 최종 수신기를 대상으로 하는 헤더에서 작동합니다.
궁극적인 수신기가 아닌 역할/행위자를 대상으로 하는 헤더는 이 API에서 무시됩니다.

요구 사항

   
지원되는 최소 클라이언트 Windows 7 [데스크톱 앱 | UWP 앱]
지원되는 최소 서버 Windows Server 2008 R2 [데스크톱 앱 | UWP 앱]
대상 플랫폼 Windows
헤더 webservices.h
라이브러리 WebServices.lib
DLL WebServices.dll