| Microsoft DirectX 8.1 (C++) |
This topic applies to Windows XP Home Edition and Windows XP Professional only.
The get_TolledObject method retrieves the object to which this toll applies.
Syntax
HRESULT get_TolledObject(
IUnknown** ppUnkTolled
);
Parameters
ppUnkTolled
[out] Pointer to a variable that receives the object’s IUnknown interface pointer.
Return Values
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
| Return code | Description |
| E_POINTER | NULL pointer. |
Remarks
The tolled object is either a denial or an offer. To determine the object type, query the IUnknown pointer for the corresponding interface, ICADenial or ICAOffer.
If the toll does contain a pointer to the tolled object, the method sets *ppUnkTolled to NULL and returns E_POINTER. This can happen because the toll has been paid, or because it was not initialized correctly.
When the method returns, if ppUnkTolled is non-NULL, the IUnknown interface has an outstanding reference count. The caller must release the interface.
Note The ICAToll interface does not include a put_TolledObject method. If you are writing a toll, and want support for script-based clients, consider implementing an equivalent method on a private interface.
See Also