Déconseiller des types et des membres (C++/CX)

  • Article

C++/CX prend en charge l’obsolescence des types et des membres Windows Runtime pour les producteurs et les consommateurs en utilisant l’attribut Deprecated. Si vous utilisez une API qui comporte cet attribut, vous recevez un message d’avertissement à la compilation. Cela indique que l’API est obsolète et recommande également une API alternative à utiliser. Dans vos propres types et méthodes publics, vous pouvez appliquer cet attribut et fournir votre message personnalisé.

Attention

L’attribut Deprecated est destiné à être utilisé uniquement avec les types Windows Runtime. Pour les classes et membres standard en C++, utilisez [[deprecated]] (C++14 et versions ultérieures) ou __declspec(deprecated).

Exemple

L'exemple suivant montre comment déconseiller vos propres API publiques, par exemple dans un composant Windows Runtime. Le deuxième paramètre, de type Windows:Foundation::Metadata::DeprecationType, spécifie si l’API est en cours d’obsolescence ou est supprimée. Actuellement, seule la valeur DeprecationType::Deprecated est prise en charge. Le troisième paramètre dans l’attribut spécifie le Windows::Foundation::Metadata::Platform auquel l’attribut s’applique.

namespace wfm = Windows::Foundation::Metadata;

public ref class Bicycle sealed
{

public:
    property double Speed;

    [wfm::Deprecated("Use the Speed property to compute the angular speed of the wheel", wfm::DeprecationType::Deprecate, 0x0)]
    double ComputeAngularVelocity();
};

Cibles prises en charge

Le tableau suivant répertorie les constructions auxquelles l’attribut Deprecated peut être appliqué :

class
enum
event
method
property
struct field

delegate
enum field
interface
constructeur paramétrable
struct
Contrôle XAML

Voir aussi

Système de types (C++/CX)
Informations de référence sur le langage C++/CX
Informations de référence sur les espaces de noms