Função UrlGetPartA (shlwapi.h)

Aceita uma cadeia de caracteres de URL e retorna uma parte especificada dessa URL.

Sintaxe

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

Parâmetros

[in] pszIn

Tipo: PCTSTR

Uma cadeia de caracteres terminada em nulo de comprimento máximo INTERNET_MAX_URL_LENGTH que contém a URL.

[out] pszOut

Tipo: PTSTR

Um ponteiro para um buffer que, quando essa função retorna com êxito, recebe uma cadeia de caracteres terminada em nulo com a parte especificada da URL.

[in, out] pcchOut

Tipo: DWORD*

Um ponteiro para um valor que, na entrada, é definido como o número de caracteres no buffer pszOut . Quando essa função retorna com êxito, o valor depende se a função é bem-sucedida ou retorna E_POINTER. Para outros valores retornados, o valor desse parâmetro não tem sentido.

dwPart

Tipo: DWORD

Os sinalizadores que especificam qual parte da URL recuperar. Ele pode ter um dos valores a seguir.

URL_PART_HOSTNAME

O nome de host.

URL_PART_PASSWORD

A senha.

URL_PART_PORT

O número da porta.

URL_PART_QUERY

A parte de consulta da URL.

URL_PART_SCHEME

O esquema da URL.

URL_PART_USERNAME

O nome de usuário.

dwFlags

Tipo: DWORD

Um sinalizador que pode ser definido para manter o esquema de URL, além da parte especificada por dwPart.

URL_PARTFLAG_KEEPSCHEME

Mantenha o esquema de URL.

Valor retornado

Tipo: HRESULT

Retorna S_OK se tiver êxito. O valor apontado por pcchOut será definido como o número de caracteres gravados no buffer de saída, excluindo o NULL de terminação. Se o buffer for muito pequeno, E_POINTER será retornado e o valor apontado por pcchOut será definido como o número mínimo de caracteres que o buffer deve ser capaz de conter, incluindo o caractere NULL de terminação. Caso contrário, um valor de erro COM será retornado.

Comentários

Observação

O cabeçalho shlwapi.h define UrlGetPart como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Cliente mínimo com suporte	Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shlwapi.h
Biblioteca	Shlwapi.lib
DLL	Shlwapi.dll (versão 5.0 ou posterior)