CBShellBoost Component
Properties Methods Events Configuration Settings Errors
The CBShellBoost component is a "gateway" to using the core functionality of CBFS Shell. With CBShellBoost, you can install and uninstall the native proxy DLL to or from the system as well as initialize it before using the core classes.
Syntax
callback.CBFSShell.Cbshellboost
Remarks
To serve Shell requests, the components are integrated with the Shell with the help of the proxy DLL, a native dynamic library that is provided for each processor architecture, supported by Windows.
Before the DLL can be used, it should be "installed" - properly registered with the Shell. Installation and deinstallation is done using the corresponding methods of this CBShellBoost component.
When an application uses the CBFS Shell components, it should initialize the native DLL before use. This is done using the Initialize method. Call it once per application session, during the initialization of the application. Do not call Initialize when you install or uninstall the native DLL.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| Attributes | This contains various options of virtual folder behavior. |
| DisplayName | This is the name that Windows Shell uses when it displays the Namespace Extension. |
| IconLocation | This contains the full path to the file with the icon. |
| NamespaceLocation | This property specifies where the extension is located in the Shell Namespace. |
| PathToDLL | This is the path to the native DLL. |
| PerUserInstallation | This specifies whether the component is registered for the current user or for all users. |
| ProductGUID | This is your product ID. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| Initialize | This method initializes the ShellBoost library. |
| Install | This method installs the native proxy DLL to the system and registers Shell folder information. |
| Uninstall | This method unregisters Shell folder information and uninstalls the native DLL from the system. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Fires if an unhandled error occurs during an event. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| EnumerationBatchSize | The RPC protocol enumeration batch size. |
| IPCErrorText | The error text that will be displayed alongside the Refresh button when the native proxy DLL in the Shell cannot communicate with the server (and your process). |
| IPCFormat | The fixed name of the RPC endpoint. |
| RefreshButtonText | The text that will be displayed on the Refresh button in the shell folder. |
| ServerStartArguments | The arguments to pass with the command. |
| ServerStartCommandLine | The command line to run when the server is not available. |
| ServerStartOperation | The operation verb. |
| ServerStartShowOption | Defines how the application windows should be shown. |
| ServerStartTimeToWait | Optional time to wait before retrying RPC connection. |
| ServerStartWorkingDirectory | The working directory. |