Object ProRibbon

Function ProRibbonDefinitionfileLoad


Description
Loads ribbon definition file from a default path.
Replacement in Object TOOLKIT: pfcSession::RibbonDefinitionfileLoad
Synopsis
#include <ProRibbon.h>
ProErrorProRibbonDefinitionfileLoad(
wchar_t* file_name
/* (In)
Name of ribbon definition file including extension name.

Note: The default search paths for finding the ribbon definition file are:

  • Current directory
  • Application text dir/ribbon
  • Application text dir/(language)/ribbon
The location of the application text directory is specified in the registry file.

*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSThe input arguments are invalid.
PRO_TK_E_NOT_FOUNDThe ribbon definition file was not found.
PRO_TK_INVALID_FILEThe file specified was not a ribbon definition file.
PRO_TK_IN_USEThe file is already loaded.

Manual References:

  1. User Interface: Ribbon Tabs, Groups, and Menu Items: To Specify the Path for the Ribbon Definition File