Функция UrlGetPartA (shlwapi.h)

Статья
11/20/2024

Принимает строку URL-адреса и возвращает указанную часть этого URL-адреса.

Синтаксис

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

Параметры

[in] pszIn

Тип: PCTSTR

Строка, завершающаяся значением NULL, INTERNET_MAX_URL_LENGTH максимальной длины, содержащей URL-адрес.

[out] pszOut

Тип: PTSTR

Указатель на буфер, который, когда эта функция возвращается успешно, получает строку, завершающуюся null, с указанной частью URL-адреса.

[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

Флаг, который можно задать для сохранения схемы URL-адресов, в дополнение к части, указанной dwPart.

URL_PARTFLAG_KEEPSCHEME

Сохраните схему URL-адреса.

Возвращаемое значение

Тип: HRESULT

Возвращает S_OK в случае успешного выполнения. Значение, на которое указывает pcchOut, будет задано число символов, записанных в выходной буфер, за исключением конца NULL. Если буфер слишком мал, возвращается E_POINTER, а значение, указываемое pcchOut, будет иметь минимальное количество символов, которые буфер должен содержать, включая завершающий символ NULL. В противном случае возвращается значение ошибки COM.

Замечания

Заметка

Заголовок shlwapi.h определяет UrlGetPart как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный, Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	shlwapi.h
библиотеки	Shlwapi.lib
DLL	Shlwapi.dll (версия 5.0 или более поздняя версия)

Поделиться через