Função UrlCreateFromPathA (shlwapi.h)

Artigo
11/20/2024

Converte um caminho do Microsoft MS-DOS em uma URL canônica.

Sintaxe

LWSTDAPI UrlCreateFromPathA(
  [in]      PCSTR pszPath,
  [out]     PSTR  pszUrl,
  [in, out] DWORD *pcchUrl,
            DWORD dwFlags
);

Parâmetros

[in] pszPath

Tipo: PCTSTR

Uma cadeia de caracteres terminada em nulo de comprimento máximo INTERNET_MAX_URL_LENGTH que contém o caminho MS-DOS.

[out] pszUrl

Tipo: PTSTR

Um ponteiro para um buffer que, quando essa função retorna com êxito, recebe a URL.

[in, out] pcchUrl

Tipo: DWORD*

O número de caracteres em pszUrl.

dwFlags

Tipo: DWORD

Reservado. Defina esse parâmetro para NULL.

Valor de retorno

Tipo: HRESULT

Retorna S_FALSE se pszPath já estiver em formato de URL. Nesse caso, pszPath será simplesmente copiado para pszUrl. Caso contrário, retornará S_OK se tiver êxito ou um valor de erro COM padrão, caso contrário.

Observações

Observação UrlCreateFromPath não dá suporte a caminhos estendidos. Estes são caminhos que incluem o prefixo de caminho de comprimento estendido "\\?\".

Nota

O cabeçalho shlwapi.h define UrlCreateFromPath 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. 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