UpdaterRegistryRegisterUpdater(IUpdater) Method |
Registers an updater application-wide, which means
the updater may get triggered in any open document.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntaxpublic static void RegisterUpdater(
IUpdater updater
)
Public Shared Sub RegisterUpdater (
updater As IUpdater
)
public:
static void RegisterUpdater(
IUpdater^ updater
)
static member RegisterUpdater :
updater : IUpdater -> unit
Parameters
- updater IUpdater
-
Updater to be registered
ExceptionsException | Condition |
---|
ArgumentException |
Updater with the the same Id has already been registered on the application level.
-or-
Updater's Id is not valid.
|
ArgumentNullException |
A non-optional argument was null
|
InvalidOperationException |
Method is not allowed during execution of a dynamic update.
-or-
The updater's owner's AddIn does not match the currently active AddIn,
i.e. IUpdater.GetUpdaterId().GetAddInId() differs from the addInId field
in the manifest file of the currently executing external application.
|
Remarks
By registering an updater application-wide, any previous registration explicitly made
for particular documents will be voided. That means the updater will no longer be connected
with just those documents, and the methodIsUpdaterRegistered(id,document) will also
return False. Consequently, any attempt to either register or unregister this updater
to (or from, respectively) a document will cause an exception to be thrown.
See Also