WsEncodeUrl 関数 (webservices.h)

指定した WS_URL を、そのコンポーネント部分を指定して URL 文字列にエンコードします。 値は必要に応じてエスケープされ、結合され、指定された WS_HEAPに格納され、結果は WS_STRINGとして返されます。

構文

HRESULT WsEncodeUrl(
  [in]           const WS_URL *url,
  [in]           ULONG        flags,
  [in]           WS_HEAP      *heap,
  [out]          WS_STRING    *outUrl,
  [in, optional] WS_ERROR     *error
);

パラメーター

[in] url

エンコードする WS_URL への参照。

[in] flags

このパラメーターの値によって、URL スキームの評価方法が決まります。 「WS_URL_FLAGS」を参照してください。

[in] heap

URL を割り当てる WS_HEAP へのポインター。

[out] outUrl

結果の URL 文字列へのポインター。

[in, optional] error

関数 が失敗 した場合にエラーに関する追加情報を格納する必要があるWS_ERROR オブジェクトへのポインター。

戻り値

この関数は、これらの値のいずれかを返すことができます。

注釈

url パラメーターでスキームが認識されない場合、関数は WS_E_INVALID_FORMATを返します。
WS_URL_SCHEME_TYPEで識別されるスキームの種類のみがサポートされています。

要件