Update newmenus.inc

This commit is contained in:
OciXCrom 2018-07-28 13:58:23 +02:00 committed by GitHub
parent b8c540a450
commit e6c6021d1e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -370,11 +370,18 @@ native menu_setprop(menu, prop, ...);
/** /**
* Gets a menu property. * Gets a menu property.
* *
* @note If the value of the property is a string, you should pass
* two additional parameters - one for the buffer and another one
* for the buffer length. Integer values are directly returned by
* the function, so no extra parameters are required.
* Example #1: menu_getprop(iMenu, MPROP_TITLE, szTitle, charsmax(szTitle))
* Example #2: new iPerPage = menu_getprop(iMenu, MPROP_PERPAGE)
*
* @param menu Menu resource identifier. * @param menu Menu resource identifier.
* @param prop MPROP_ constant. * @param prop MPROP_ constant.
* @param ... Property parameters. * @param ... Property parameters.
* @return Menu property if the property type is an integer. * @return Menu property if the property type is an integer.
* @error Invalid menu resource or property. * @error Invalid menu resource, invalid property or invalid amount of parameters.
*/ */
native menu_getprop(menu, prop, ...); native menu_getprop(menu, prop, ...);