SOAP_HEADER 関数 [SOAP]

SOAP ヘッダ・エントリまたは SOAP 要求のヘッダ・エントリの属性値を返します。

SOAP_HEADER( header-key [ index, header-attribute ] )

header-key VARCHAR パラメータには、特定の SOAP ヘッダ・エントリで最上位層にある XML 要素の XML ローカル名を指定します。
index このオプションの INTEGER パラメータは、同じ名前の SOAP ヘッダ・フィールドでも違いを見つけます。同じ名前になる状況は、複数のヘッダ・エントリが同じ localname を持つ最上位 XML 要素がある場合に発生します。通常、このような要素には一意の番号空間があります。
header-attribute オプションの VARCHAR パラメータは、次に示すヘッダ・エントリ要素内にある任意の属性ノードです。
- @namespace 特定のヘッダ・エントリの名前空間にアクセスするときに使用する特殊な SQL Anywhere 属性。
- mustUnderstand ヘッダ・エントリが必須かオプションかを処理する受信者に示す SOAP 1.1 のヘッダ・エントリ属性。
- encodingStyle エンコーディング・スタイルを示す SOAP 1.1 ヘッダ・エントリ属性。この属性にはアクセスできますが、SQL Anywhere の内部では使用されません。
- actor 受信者の URL を指定することで、ヘッダ・エントリの受信者を示す SOAP 1.1 ヘッダ・エントリ属性。

LONG VARCHAR

この関数は、単一のパラメータ header-key を使用してヘッダ・エントリを返すときに使用します。ヘッダ・エントリは、SOAP ヘッダに含まれている要素と、その要素に含まれるすべての部分要素を XML 文字列で表現したものです。

この関数は、オプションの index と header-attribute パラメータを指定して、ヘッダ・エントリ属性を抽出するときにも使用できます。

この関数は、指定された SOAP ヘッダ・フィールドの値を返します。SOAP サービスから呼び出されていない場合は NULL を返します。Web サービスを介して SOAP 要求を処理する場合に使用します。

指定した header-key のヘッダが存在しない場合、戻り値は NULL です。