UrlGetPartA 関数 (shlwapi.h)

URL 文字列を受け取り、その URL の指定された部分を返します。

構文

LWSTDAPI UrlGetPartA(
  [in]      PCSTR pszIn,
  [out]     PSTR  pszOut,
  [in, out] DWORD *pcchOut,
            DWORD dwPart,
            DWORD dwFlags
);

パラメーター

[in] pszIn

種類: PCTSTR

URL を含む最大長INTERNET_MAX_URL_LENGTHの null で終わる文字列。

[out] pszOut

種類: PTSTR

この関数が正常に返されると、URL の指定された部分を持つ null で終わる文字列を受け取るバッファーへのポインター。

[in, out] pcchOut

種類: DWORD*

入力時に pszOut バッファー内の文字数に設定される値へのポインター。 この関数が正常に返された場合、値は関数が成功したか、E_POINTERを返すかによって異なります。 その他の戻り値の場合、このパラメーターの値は意味がありません。

dwPart

型: DWORD

取得する URL のどの部分を指定するフラグ。 次のいずれかの値を指定できます。

URL_PART_HOSTNAME

ホスト名です。

URL_PART_PASSWORD

パスワード。

URL_PART_PORT

ポート番号。

URL_PART_QUERY

URL のクエリ部分。

URL_PART_SCHEME

URL スキーム。

URL_PART_USERNAME

ユーザー名。

dwFlags

型: DWORD

dwPart で指定された部分に加えて、URL スキームを保持するように設定できるフラグ。

URL_PARTFLAG_KEEPSCHEME

URL スキームをそのまま使用します。

戻り値

種類: HRESULT

成功した場合は、S_OKを返します。 pcchOut が指す値は、出力バッファーに書き込まれた文字数に設定され、終端の NULL は除きます。 バッファーが小さすぎる場合は、E_POINTERが返され、 pcchOut によって指される値は、終端の NULL 文字を含め、バッファーに格納できる必要がある最小文字数に設定されます。 それ以外の場合は、COM エラー値が返されます。

解説

注意

shlwapi.h ヘッダーは UrlGetPart をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

サポートされている最小のクライアント	Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	shlwapi.h
Library	Shlwapi.lib
[DLL]	Shlwapi.dll (バージョン 5.0 以降)