Função UrlGetPartW (shlwapi.h)

Artigo
11/20/2024

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

Sintaxe

LWSTDAPI UrlGetPartW(
  [in]      PCWSTR pszIn,
  [out]     PWSTR  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 seguintes valores.

URL_PART_HOSTNAME

O nome do host.

URL_PART_PASSWORD

A senha.

URL_PART_PORT

O número da porta.

URL_PART_QUERY

A parte da consulta da URL.

URL_PART_SCHEME

O esquema de 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 de retorno

Tipo: HRESULT

Retorna S_OK se bem-sucedido. O valor apontado por pcchOut será definido como o número de caracteres gravados no buffer de saída, excluindo o nulo. 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 null. Caso contrário, um valor de erro COM será retornado.

Observações

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	shlwapi.h
biblioteca	Shlwapi.lib
de DLL	Shlwapi.dll (versão 5.0 ou posterior)

Compartilhar via