Compartilhar via


CMenu::GetMenuString

Copia o rótulo do item de menu especificado no buffer especificado.

int GetMenuString( 
   UINT nIDItem, 
   LPTSTR lpString, 
   int nMaxCount, 
   UINT nFlags  
) const; 
int GetMenuString( 
   UINT nIDItem, 
   CString& rString, 
   UINT nFlags  
) const;

Parâmetros

  • nIDItem
    Especifica o identificador inteiro de item de menu ou o deslocamento do item de menu no menu, dependendo do valor de nFlags.

  • lpString
    Aponta para o buffer que deve receber o rótulo.

  • rString
    Uma referência a um objeto de CString que é receber a cadeia de caracteres cópias do menu.

  • nMaxCount
    Especifica o comprimento máximo (de caracteres) do rótulo seja copiada. Se o rótulo é maior que o máximo especificado em nMaxCount, os caracteres adicionais são truncados.

  • nFlags
    Especifica a interpretação de parâmetro de nIDItem . Pode ser um dos seguintes valores:

    nFlags

    Interpretação de nIDItem

    MF_BYCOMMAND

    Especifica que o parâmetro fornece a identificação do comando de menu item existente. Esta é a opção se nem nem MF_BYCOMMANDMF_BYPOSITION são definidos.

    MF_BYPOSITION

    Especifica que o parâmetro retorna a posição do item de menu existente. O primeiro item está na posição 0.

Valor de retorno

Especifica o número real de caracteres copiados para o buffer, incluindo o terminador não nulo.

Comentários

O parâmetro de nMaxCount deve ser maior do que o número de caracteres no rótulo para acomodar o caractere nulo que termina uma cadeia de caracteres.

Exemplo

Consulte o exemplo para CMenu::InsertMenu.

Requisitos

Cabeçalho: afxwin.h

Consulte também

Referência

Classe CMenu

Gráfico da hierarquia

CMenu::GetMenuState

CMenu::ModifyMenu

GetMenuString