winuser.h


GetMenuString

La función GetMenuString copia la cadena de texto del ítem de menú especificado en el búfer indicado.

GetMenuString funciona, pero es obsoleta. En su lugar se debe usar GetMenuItemInfo.

Sintaxis

int GetMenuString(
    HMENU hMenu,      // manipulador de menú
    UINT uIDItem,     // identificador del ítem de menú
    LPTSTR lpString,  // puntero al búfer para la cadena
    int nMaxCount,    // longitud máxima de la cadena
    UINT uFlag        // banderas de menú
   );

Parámetros

hMenu: identifica el menú.

uIDItem: especifica el ítem de menú cuyo texto se recupera, tal como determine el parámetro uFlag.

lpString: apunta al búfer que recibe la cadena terminada en cero.

Si lpString es NULL, la función devuelve la longitud de la cedena del menú.

nMaxCount: especifica la longitud máxima, en caracteres, de la cadena a copiar. Si la cadena es más larga que el máximo especificado en el parámetro nMaxCount, los caracteres extra se truncan.

Si nMaxCount es 0, la función devuelve la longitud de la cadena del menú.

uFlag: especifica cómo se interpreta el parámetro uIdItem. Este parámetro puede ser uno de los valores siguientes:

Valor Descripción
MF_BYCOMMAND Indica que el parámetro uId proporciona el identificador del ítem de menú. La bandera MF_BYCOMMAND es el valor por defecto si no se especifica ni MF_BYCOMMAND ni MF_BYPOSITION.
MF_BYPOSITION Indica que el parámetro uId proporciona la posición relativa, empezando en cero, del ítem de menú.

Valor de retorno

Si la función tiene éxito, el valor de retorno especifica el número de caracteres copiados al búfer, sin incluir el carácter nulo terminador.

Si la función falla, el valor de retorno es cero.

Observaciones

El parámetro nMaxCount debe ser una unidad mayor que el número de caracteres en la cadena de texto para poder añadir el carácter nulo terminador.

Si nMaxCount es 0, la función devuelve la longitud de la cadena de menú.