UrlGetPartW, fonction (shlwapi.h)

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 un caractère 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éfinie sur le nombre de caractères dans la mémoire tampon pszOut . Lorsque cette fonction retourne correctement, la valeur varie selon que la fonction réussit ou retourne E_POINTER. Pour les autres valeurs de retour, la valeur de ce paramètre n’a aucun sens.

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 requête de l’URL.

URL_PART_SCHEME

Schéma d’URL.

URL_PART_USERNAME

Le 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 retournée

Type : HRESULT

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

Remarques

Configuration requise