Share via

PurgeOnDelete Property of the IFPCMailAntivirusSettings Interface

  • Article

The PurgeOnDelete property gets or sets a Boolean value that indicates whether the entire message will be purged if its body needs to be deleted.

C++

HRESULT put_PurgeOnDelete(
    VARIANT_BOOL fPurgeOnDelete
);
HRESULT get_PurgeOnDelete(
    VARIANT_BOOL* pfPurgeOnDelete
);

Parameters

  • fPurgeOnDelete
    Boolean value that indicates whether the entire message will be purged if its body needs to be deleted.

  • pfPurgeOnDelete
    Pointer to a Boolean variable that is set on return to VARIANT_TRUE if the entire message will be purged if its body needs to be deleted, or to VARIANT_FALSE if the entire message will not be purged when a message body is 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 the entire message will be purged if its body needs to be deleted.

Remarks

This property is read/write. Its default value is True (VARIANT_TRUE in C++).

Requirements

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.
DLL

Requires Msfpccom.dll.

See Also

FPCMailAntivirusSettings

Send comments about this topic to Microsoft

Build date: 6/30/2010