Fonction UrlApplySchemeA (shlwapi.h)

Article
03/04/2024

Détermine un schéma pour une chaîne d’URL spécifiée et retourne une chaîne avec un préfixe approprié.

Syntaxe

LWSTDAPI UrlApplySchemeA(
  [in]      PCSTR pszIn,
  [out]     PSTR  pszOut,
  [in, out] DWORD *pcchOut,
            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 une 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 définie sur l’URL spécifiée par pszIn et convertie au format scheme ://URL_string standard.

[in, out] pcchOut

Type : DWORD*

Adresse d’une valeur définie sur le nombre de caractères dans la mémoire tampon pszOut . Lorsque la fonction retourne, 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.

dwFlags

Type : DWORD

Indicateurs qui spécifient comment déterminer le schéma. Les indicateurs suivants peuvent être combinés.

URL_APPLY_DEFAULT

Appliquez le schéma par défaut si UrlApplyScheme ne peut pas en déterminer un. Le préfixe par défaut est stocké dans le Registre, mais est généralement « http ».

URL_APPLY_GUESSSCHEME

Essayez de déterminer le schéma en examinant pszIn.

URL_APPLY_GUESSFILE

Essayez de déterminer une URL de fichier à partir de pszIn.

URL_APPLY_FORCEAPPLY

Forcez UrlApplyScheme à déterminer un schéma pour pszIn.

Valeur retournée

Type : HRESULT

Retourne une valeur de retour COM standard, y compris les éléments suivants.

Code de retour	Description
S_OK	Un schéma a été déterminé. pszOut pointe vers une chaîne contenant l’URL avec le préfixe du schéma. La valeur de pcchOut est définie sur le nombre de caractères dans la chaîne, sans compter le caractère NULL de fin.
S_FALSE	Il n’y a pas eu d’erreurs, mais aucun préfixe n’a été ajouté.
E_POINTER	La mémoire tampon était trop petite. La valeur de 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.

Remarques

Si l’URL a un schéma valide, la chaîne n’est pas modifiée. Toutefois, presque toutes les combinaisons de deux caractères ou plus suivis d’un signe deux-points sont analysées en tant que schéma. Les caractères valides incluent des signes de ponctuation courants, tels que « ». Si votre chaîne d’entrée correspond à cette description, UrlApplyScheme peut la traiter comme valide et ne pas appliquer de schéma. Pour forcer la fonction à appliquer un schéma à une URL, définissez les indicateurs URL_APPLY_FORCEAPPLY et URL_APPLY_DEFAULT dans dwFlags. Cette combinaison d’indicateurs force la fonction à appliquer un schéma à l’URL. En règle générale, la fonction ne peut pas déterminer un schéma valide. Le deuxième indicateur garantit que, si aucun schéma valide ne peut être déterminé, la fonction applique le schéma par défaut à l’URL.

Notes

L’en-tête shlwapi.h définit UrlApplyScheme en tant qu’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. La combinaison 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.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shlwapi.h
Bibliothèque	Shlwapi.lib
DLL	Shlwapi.dll (version 5.0 ou ultérieure)

Partager via