PurgeOnDelete Property of the IFPCMailAntivirusSettings Interface

The PurgeOnDelete property gets or sets a Boolean value that indicates whether to purge messages that had their body deleted.

[C++]
HRESULT put_PurgeOnDelete(
	VARIANT_BOOL fPurgeOnDelete
);
HRESULT get_PurgeOnDelete(
	VARIANT_BOOL* pfPurgeOnDelete
);

Parameters

pfPurgeOnDelete

Pointer to a Boolean variable that is set on return to VARIANT_TRUE if the purging of messages that had their body deleted is enabled, or to VARIANT_FALSE if the purging of messages that had their body deleted is not enabled.

fPurgeOnDelete

Boolean value that indicates whether to purge messages that had their body deleted.

Return Value

These property methods return S_OK if the call is successful; otherwise, they return an error code.

[Visual Basic]
Property PurgeOnDelete As Boolean

Property Value

Boolean value that indicates whether to purge messages that had their body deleted.

Remarks

This property is read/write. Its default value is False (VARIANT_FALSE in C++).

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCMailAntivirusSettings


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.