npMine plugin

About this plugin

This plugin allows you to search for text under the Windows Registry looking for keys, values and also text values contents. The plugin report all processed keys, matched keys, matched values and matches content values.

The plugin allows you to search in two diferents ways: automagically in one or more root keys or in a more accurate way. The plugin offer you the appropiate events which are fired when process keys, match keys, values, etc.

Thirparty

This plugin are imposible without the aid of this people:

Thanks a lot!

Plugin actions index

npMineCreate

Create a new instance of an Mine object. The result variable store the numeric ID of the new created Mine object instance. You need this ID on other plugins actions.

↑↑

npMineDestroy

Destroy a previously created instanace of an Mine object. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npMineDestroyAll

Destroy all previously created instances of Mine objects.

↑↑

npMineSearch

Search the query under the appropiate key into the Windows Registry using the specified Mine object instance. This action allows you to search under the specific root and initial keys. You can use one of this values for the root key: HKEY_USERS, HKEY_DYN_DATA, HKEY_CLASSES_ROOT, HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, HKEY_CURRENT_CONFIG, HKEY_PERFORMANCE_DATA.

The default initial key is "\" (without quotes) which means to search into the entire root key. You can also specify a more accurate initial key like: "\Software\" (again without quotes) to indicate you only want to search into this specific key and their subkeys. Determine the search query and also if you want a case sensitive search or not.

The plugin fire the appropiate events (process key, match key, match value, etc.) and you can specify the appropiate NeoBook subroutines to respond to these events. The action result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npMineSearchEx

Search the query under all the Windows Registry using the specified Mine object instance. This actions allows you to search under the specified root keys. The plugin search for you automatically in all the specified root keys and their subkeys. If you need a more accurate way to search can use npMineSearch instead.

The plugin fire the appropiate events (process key, match key, match value, etc.) and you can specify the appropiate NeoBook subroutines to respond to these events. The action result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npMineAbort

Abort the specified Mine object search task. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npMineIsSearch

Determine if the specified Mine object is currently searching or not. The result variable store "True" if a search is in process or "False" if not or in case of error. In this last case the [LastError] contain information about the error.

↑↑

npOnMineAbort

Set a subroutine to be executed when the specified Mine object abort event is fired. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnMineFinish

Set a subroutine to be executed when the specified Mine object finish event is fired. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnMineProcessKey

Set a subroutine to be executed when the specified Mine object process key event is fired. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnMineMatchKey

Set a subroutine to be executed when the specified Mine object match key event is fired. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnMineMatchValue

Set a subroutine to be executed when the specified Mine object match value event is fired. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

npOnMineMatchContent

Set a subroutine to be executed when the specified Mine object match content event is fired. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] contain information about the error.

↑↑

Action errors subroutine

All the NeoPlugins deal with errors in the same way that NeoBook does: when the plugin found an action error the [LastError] variable store information about the error, so you can take care about this variable when execute an action.

But all the NeoPlugins also incorporate an advanced way to deal with possible action errors. You can define a subroutine named OnNeoPluginActionError in order to be executed when some action error are found and you can use this variables inside:

Note that this error handling subroutine are shared for all the NeoPlugins, so you no need to specify a subroutine for every plugin you use in your publication because the same subroutine are recognized and automagically used by every NeoPlugin. Below you can view a sample of this subroutine code:

:OnNeoPluginActionError
  AlertBox "NeoPlugin Error" "Error [LastError] in plugin: [PluginName]"
Return

Also note that the use of this NeoPlugins error handling subroutine is completelly optional. You can continue using the [LastError] variable as usual and even use the both methods at the same time.

↑↑