Description Property of the IFPCSmtpRoute Interface

  • Article

The Description property gets or sets the description of the route.

C++

HRESULT put_Description(
    BSTR bstrDescription
);
HRESULT get_Description(
    BSTR* pbstrDescription
);

Parameters

  • bstrDescription
    BSTR that specifies the description of the route.

  • pbstrDescription
    Pointer to a BSTR that is set on return to a string value specifying the description of the route.

Return Value

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

Visual Basic

Property Description As String

Property Value

String that specifies the description of the route.

Remarks

This property is read/write. Its default value is an empty string.

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

FPCSmtpRoute

Send comments about this topic to Microsoft

Build date: 6/30/2010