CButton::GetNote
Ruft den Hinweistext ab, der dem aktuellen Befehlslink-steuerelement zugeordnet ist.
CString GetNote() const;
BOOL GetNote(
LPTSTR lpszNote,
UINT* cchNote
) const;
Parameter
Parameter |
Description |
|---|---|
[out] lpszNote |
Zeiger auf einen Puffer, der der Aufrufer zum Belegen und Freigeben zuständig ist. Wenn der Rückgabewert true ist, enthält der Puffer den Hinweistext, der dem aktuellen Befehlslink-steuerelement zugeordnet wird; andernfalls ist der Puffer unverändert. |
[in, out] cchNote |
Ein Zeiger auf eine ganzzahlige Variable ohne Vorzeichen. Wenn diese Methode aufgerufen wird, enthält die Variable die Größe des Puffers, der vom lpszNote-Parameter angegeben wird. Wenn diese Methode zurückgibt, wenn der Rückgabewert true ist, enthält die Variable die Größe des Hinweises, der dem aktuellen Befehlslink-steuerelement zugeordnet ist. Wenn der Rückgabewert false ist, enthält die Variable die Puffergröße, die erforderlich ist, um den Hinweis zu enthalten. |
Rückgabewert
In der ersten Überladung ein CString-Objekt, das den Hinweistext enthält, der dem aktuellen Befehlslink-steuerelement zugeordnet ist.
- oder -
In der zweiten Überladung true, wenn diese Methode erfolgreich ist; andernfalls false.
Hinweise
Verwenden Sie diese Methode nur mit Steuerelementen, deren Schaltflächenformat BS_COMMANDLINK oder BS_DEFCOMMANDLINK ist.
Diese Methode sendet die BCM_GETNOTE Meldung, die im Windows SDK beschrieben wird.
Anforderungen
Header: afxwin.h
Diese Methode wird in Windows Vista und höher unterstützt.
Zusätzliche Anforderungen für diese Methode werden in Anforderungen für die Erstellung von Windows Vista-Standardsteuerelementen beschrieben.