WsAddCustomHeader 함수(webservices.h)

  • 아티클

지정된 애플리케이션 정의 헤더를 메시지에 추가합니다.

구문

HRESULT WsAddCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *headerDescription,
  [in]           WS_WRITE_OPTION              writeOption,
  [in, ref]      const void                   *value,
  [in]           ULONG                        valueSize,
  [in]           ULONG                        headerAttributes,
  [in, optional] WS_ERROR                     *error
);

매개 변수

[in] message

헤더를 추가할 메시지입니다.

메시지는 WS_MESSAGE_STATE_EMPTY 제외한 모든 상태일 수 있습니다( WS_MESSAGE_STATE 열거형 참조).

[in] headerDescription

헤더를 설명하는 WS_ELEMENT_DESCRIPTION 구조체입니다.

[in] writeOption

헤더 요소가 필요한지 여부와 값이 할당되는 방식입니다. 자세한 내용은 WS_WRITE_OPTION 열거형을 참조하세요.

[in, ref] value

serialize할 헤더 값입니다. 자세한 내용은 WS_WRITE_OPTION 열거형을 참조하세요.

[in] valueSize

serialize되는 값의 크기(바이트)입니다.

[in] headerAttributes

헤더에 대한 SOAP 특성의 값입니다.

[in, optional] error

함수가 실패할 경우 추가 오류 정보를 수신하는 WS_ERROR 구조체에 대한 포인터입니다.

반환 값

함수가 성공하면 NO_ERROR 반환합니다. 그렇지 않으면 HRESULT 오류 코드를 반환합니다.

반환 코드 설명
WS_E_INVALID_FORMAT
 메시지에 동일한 유형의 헤더가 여러 인스턴스가 있습니다.
E_OUTOFMEMORY
 메모리가 부족하여 작업을 완료할 수 없습니다.
E_INVALIDARG
 하나 이상의 매개 변수가 잘못되었습니다.
기타 오류
이 함수는 위에 나열되지 않은 다른 오류를 반환할 수 있습니다.

설명

WsAddCustomHeader 함수는 최종 수신기를 대상으로 하는 헤더 유형을 처리하도록 설계되었습니다. 다른 수신기를 대상으로 하는 헤더는 무시됩니다.

헤더를 바꾸는 경우 WsAddCustomHeader를 호출하기 전에 WsRemoveCustomHeader 함수를 호출하여 헤더의 기존 인스턴스를 제거합니다.

요구 사항

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