CoReleaseServerProcess (Compact 2013)

3/26/2014

This function decrements the global per-process reference count

Syntax

ULONG CoReleaseServerProcess(void);

Parameters

None.

Return Value

• 0
  The server application should initiate its cleanup.

• Other values
  Server application should not yet initiate its cleanup.

Remarks

Servers can call CoReleaseServerProcess to decrement a global per-process reference count incremented through a call to CoAddRefServerProcess.

When that count reaches zero, OLE automatically calls CoSuspendClassObjects, which prevents new activation requests from coming in. This permits the server to deregister its class objects from its various threads without worry that another activation request may come in. New activation requests result in launching a new instance of the local server process.

The simplest way for a local server application to make use of these API functions is to call CoAddRefServerProcess in the constructor for each of its instance objects, and in each of its IClassFactory::LockServer methods when the fLock parameter is TRUE.

The server application should also call CoReleaseServerProcess in the destruction of each of its instance objects, and in each of its IClassFactory::LockServer methods when the fLock parameter is FALSE.

Finally, the server application must check the return code from CoReleaseServerProcess; if it returns 0, the server application should initiate its cleanup. This typically means that a server with multiple threads should signal its various threads to exit their message loops and call CoRevokeClassObject and CoUninitialize.

If these APIs are used at all, they must be called in both the object instances and the LockServer method, otherwise the server application may be shutdown prematurely. In-process servers typically should not call CoAddRefServerProcess or CoReleaseServerProcess.

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

See Also

Reference

COM Functions