IFPCLinkTranslationPatterns::Add method

  • Article

Applies to: desktop apps only

The Add method adds a new pattern matching expression to the collection.

Syntax

HRESULT Add(
  [in]  BSTR Name
);

FPCLinkTranslationPatterns.Add( _
  ByVal Name As String _
)

Parameters

  • Name [in]

    C++ Required. BSTR that specifies the new pattern matching expression.
    VB Required. String that specifies the new pattern matching expression.

    Each pattern matching expression in the collection must have either the form A*B or the form A. In the former case, the search pattern is <!--A*B-->, and in the latter case, the search pattern is <!--A-->.

Return value

C++

This method returns S_OK if the call is successful; otherwise, it returns an error code.

VB

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

As an example of a pattern matching expression of the form A*B, consider the predefined pattern matching expression CURRENT FILE==*replyforwardnote for the scenario in which an internal user sends an email message containing URLs that contain names of internal servers. If a recipient accesses the message through a Forefront TMG computer by using Microsoft Office Outlook Web Access for Exchange Server 2003, the URLs viewed by the recipient contain public names.

Forefront TMG uses pattern matching to ensure that the public names remain in links when a message is forwarded or a reply is sent. Replies and forwarded Microsoft Outlook Web Access messages contain the following line:

<!--CURRENT FILE=="IE5" "WIN32" replyforwardnote-->

Forefront TMG uses the predefined pattern matching expression to determine if a line like this is present by searching for a string that starts with <!--CURRENT FILE== and ends with replyforwardnote--> and does not contain < or > in between. When Forefront TMG identifies such a line, it does not perform link translation so that internal recipients will receive URLs with internal names.

Requirements

Minimum supported client

 Windows Vista

Minimum supported server

 Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

 Forefront Threat Management Gateway (TMG) 2010

IDL

 Msfpccom.idl

DLL

 Msfpccom.dll

See also

FPCLinkTranslationPatterns

 

 

Build date: 7/12/2010