CUrl::CreateUrl

[アーティクル]
08/09/2011

このメソッドは、CUrl オブジェクトを構成する各フィールドから URL 文字列を作成します。

inline BOOL CreateUrl(
   LPTSTR lpszUrl,
   DWORD* pdwMaxLength,
   DWORD dwFlags = 0 
) const throw( );

パラメーター

lpszUrl
完成した URL 文字列を保持する文字列バッファー。
pdwMaxLength
lpszUrl 文字列バッファーの最大長。
dwFlags
ATL_URL_ESCAPE を指定すると、lpszUrl 内のすべてのエスケープ文字を実際の値に変換します。

戻り値

正常に終了した場合は TRUE を返します。それ以外の場合は FALSE を返します。

解説

このメソッドは、次の形式に従って個々のフィールドを付け加えて、URL 文字列を完成させます。

<scheme>://<user>:<pass>@<domain>:<port><path><extra>

このメソッドを呼び出す場合、最初に、lpszUrl パラメーターによって参照される文字列バッファーの最大長を pdwMaxLength パラメーターで指定しておく必要があります。 pdwMaxLength パラメーターの値は、URL 文字列の実際の長さで更新されます。

使用例

次のサンプルは、CUrl オブジェクトを作成して、その URL 文字列を取得する例です。

CUrl url;

// Set the CUrl contents
url.CrackUrl(_T("https://someone:secret@www.microsoft.com:8080/visualc/stuff.htm#contents"));

// Obtain the length of the URL string and allocate a buffer to 
// hold its contents
DWORD dwUrlLen = url.GetUrlLength() + 1;
TCHAR* szUrl = new TCHAR[dwUrlLen];

// Retrieve the contents of the CUrl object
url.CreateUrl(szUrl, &dwUrlLen, 0L);

// Cleanup
delete[] szUrl;