IObjectExporter::SimplePing

[idempotent] error_status_t SimplePing
    (
    [in]  handle_t  hRpc,
    [in]  SETID    *pSetId
    );

Pings provide a mechanism to garbage collect interfaces. If an interface has references but is not being pinged, it may be released. Conversely, if an interface has no references, it may be released even though it has recently been pinged. SimplePing just pings the contents of a set. The set must be created with ComplexPing (see below).

Ping a set, previously created with IObjectExporter::ComplexPing, of OIDs owned by this Object Exporter. Note that neither IPIDs nor OIDs may be pinged, only explicitly created SETIDs.

Argument

Type

Description

hRpc	handle_t	An RPC binding handle used to make the request.
pSetId	SETID*	A SETID previously created with IObjectExporter::ComplexPing on this same Object Exporter.

Return Value

Meaning

S_OK	Success. The set was pinged.
RPC_E_INVALID_SET	This SETID is unknown to this Object Exporter, and thus the ping did not occur.
E_UNEXPECTED	An unspecified error occurred. It is not known whether the ping was done or not.