Partager via


CButton::GetNote

Extrait le texte de remarque associé au contrôle de lien en cours de commande.

CString GetNote() const;
BOOL GetNote(
     LPTSTR lpszNote, 
     UINT* cchNote
) const;

Paramètres

Paramètre

Description

[out] lpszNote

Pointeur vers une mémoire tampon, qui l'appelant est chargé d'allouer et à libérer. Si la valeur de retour est true, la mémoire tampon contient le texte de remarque associé au contrôle de lien en cours de commande ; sinon, la mémoire tampon reste inchangée.

[in, out] cchNote

Un pointeur vers une variable d'entier non signé.

Lorsque cette méthode est appelée, la variable contient la taille de la mémoire tampon spécifiée par le paramètre d' lpszNote .

Lorsque cette méthode retourne, si la valeur de retour est true la variable contient la taille de la remarque associé à un contrôle de lien en cours de commande. Si la valeur de retour est false, la variable contient la taille de mémoire tampon requise pour contenir la remarque.

Valeur de retour

Dans la première surcharge, un objet de CString qui contient le texte de remarque associé à un contrôle de lien en cours de commande.

ou

Dans la deuxième surcharge, true si cette méthode est réussie ; sinon, false.

Notes

Utilisez cette méthode uniquement avec les contrôles dont le style de boutons est BS_COMMANDLINK ou BS_DEFCOMMANDLINK.

Cette méthode envoie le message de BCM_GETNOTE , qui est décrit dans Kit de développement logiciel Windows. 

Configuration requise

en-tête : afxwin.h

Cette méthode est prise en Windows Vista et versions ultérieures.

Les spécifications supplémentaires pour cette méthode sont décrites dans Spécifications pour la génération des contrôles communs Windows Vista.

Voir aussi

Référence

CButton, classe

Graphique de la hiérarchie

CButton::SetNote

CButton::GetNoteLength

BCM_GETNOTE