UrlGetPartW 関数 (shlwapi.h)

[アーティクル]
11/20/2024

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

構文

LWSTDAPI UrlGetPartW(
  [in]      PCWSTR pszIn,
  [out]     PWSTR  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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして UrlGetPart を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional、Windows XP [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	shlwapi.h
ライブラリ	Shlwapi.lib
DLL	Shlwapi.dll (バージョン 5.0 以降)

次の方法で共有