Microsoft DirectX 8.1 (C++)

ICAPolicy::get_OkToRemove

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The get_OkToRemove method determines whether the policy can be removed.

Syntax

HRESULT get_OkToRemove(
  BOOL*  pfOkToRemove
);

Parameters

  pfOkToRemove

[out]  Pointer to variable that receives a Boolean value. If the value is TRUE, the policy can be removed. Otherwise, it cannot.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The ICAPolicies::Remove method calls this method to confirm that it has permission to remove the policy. A software policy should always return the value FALSE. A DirectShow filter policy is responsible for removing itself before the filter leaves the graph. Therefore, a filter policy should return FALSE until the filter is ready to remove itself. At that point, it should return TRUE. Typically, this happens inside the filter�s IBaseFilter::JoinFilterGraph method.

See Also