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

Статья
08/26/2023

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

Синтаксис

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

Параметры

[in] pszIn

Тип: PCTSTR

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

[out] pszOut

Тип: PTSTR

Указатель на буфер, который при успешном возврате этой функции получает строку, завершающуюся нулевым значением, с указанной частью 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 Professional, Windows XP [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	shlwapi.h
Библиотека	Shlwapi.lib
DLL	Shlwapi.dll (версия 5.0 или более поздняя)

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