Edit

ICOMAdminCatalog2::RecycleApplicationInstances method (comadmin.h)

  • Article

Recycles (shuts down and restarts) the specified application server processes.

Syntax

HRESULT RecycleApplicationInstances(
  [in] VARIANT *pVarApplicationInstanceID,
  [in] long    lReasonCode
);

Parameters

[in] pVarApplicationInstanceID

The application instances to be recycled. Each element of the Variant may be a String containing an application instance GUID (for example, as returned by the GetApplicationInstanceIDFromProcessID method), a single catalog object, or a catalog collection (for example, as returned by the GetCollectionByQuery2 method).

[in] lReasonCode

The reason for recycling the specified application instances. This code is written to an event log entry.

Return value

This method can return the standard return values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following values.

Return code Description
S_OK
 The method completed successfully.
COMADIN_E_OBJECT_DOES_NOT_EXIST
 A specified application instance does not exist.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header comadmin.h

See also

ICOMAdminCatalog2