UrlGetPartW, fonction (shlwapi.h)

Article
11/20/2024

Accepte une chaîne d’URL et retourne une partie spécifiée de cette URL.

Syntaxe

LWSTDAPI UrlGetPartW(
  [in]      PCWSTR pszIn,
  [out]     PWSTR  pszOut,
  [in, out] DWORD  *pcchOut,
            DWORD  dwPart,
            DWORD  dwFlags
);

Paramètres

[in] pszIn

Type : PCTSTR

Chaîne terminée par null de longueur maximale INTERNET_MAX_URL_LENGTH qui contient l’URL.

[out] pszOut

Type : PTSTR

Pointeur vers une mémoire tampon qui, lorsque cette fonction retourne correctement, reçoit une chaîne terminée par null avec la partie spécifiée de l’URL.

[in, out] pcchOut

Type : DWORD*

Pointeur vers une valeur qui, lors de l’entrée, est défini sur le nombre de caractères dans la mémoire tampon pszOut. Lorsque cette fonction est retournée avec succès, la valeur dépend de la réussite de la fonction ou de la E_POINTER. Pour les autres valeurs de retour, la valeur de ce paramètre est sans signification.

dwPart

Type : DWORD

Indicateurs qui spécifient la partie de l’URL à récupérer. Il peut avoir l’une des valeurs suivantes.

URL_PART_HOSTNAME

Nom d’hôte.

URL_PART_PASSWORD

Mot de passe.

URL_PART_PORT

Numéro de port.

URL_PART_QUERY

Partie de requête de l’URL.

URL_PART_SCHEME

Schéma d’URL.

URL_PART_USERNAME

Nom d’utilisateur.

dwFlags

Type : DWORD

Indicateur qui peut être défini pour conserver le schéma d’URL, en plus de la partie spécifiée par dwPart.

URL_PARTFLAG_KEEPSCHEME

Conservez le schéma d’URL.

Valeur de retour

Type : HRESULT

Retourne S_OK en cas de réussite. La valeur pointée par pcchOut sera définie sur le nombre de caractères écrits dans la mémoire tampon de sortie, à l’exclusion de la fin NULL. Si la mémoire tampon était trop petite, E_POINTER est retournée et la valeur indiquée par pcchOut sera définie sur le nombre minimal de caractères que la mémoire tampon doit contenir, y compris la fin caractère NULL. Sinon, une valeur d’erreur COM est retournée.

Remarques

Note

L’en-tête shlwapi.h définit UrlGetPart comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	shlwapi.h
bibliothèque	Shlwapi.lib
DLL	Shlwapi.dll (version 5.0 ou ultérieure)

Partager via