Add Method of the IFPCCacheDrives Interface

The Add method creates a new FPCCacheDrive object in the collection and returns a reference to it. The Save method must be called for the additional FPCCacheDrive object to be saved to persistent storage.

a Forefront TMG cache drive must be in NTFS format, and have a minimum size of 5 megabytes.

[C++]

Syntax

HRESULT Add(
  [in]   BSTR Name,
  [in]   long CacheLimitInMegs,
  [out]  IFPCCacheDrive** ppNewCacheDrive
);

Parameters

Name
Required. BSTR that specifies the name of the new cache drive, such as "C:".
CacheLimitInMegs

Required. A 32-bit integer that specifies the size, in megabytes, allocated to the cache in this particular drive.

ppNewCacheDrive

Address of an interface pointer that on return points to the new IFPCCacheDrive interface added.

Return Value

This method can return one of the following:

[Visual Basic]

Syntax

Function Add( _
  ByVal Name As String, _
  ByVal CacheLimitInMegs As Long _
) As FPCCacheDrive

Parameters

Name
Required. String that specifies the name of the new cache drive, such as "C:".
CacheLimitInMegs

Required. A 32-bit integer that specifies the size, in megabytes, allocated to the cache in this particular drive.

Return Value

This method returns a reference to the FPCCacheDrive object added if the call is successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

When you add a drive to the FPCCacheDrives collection, and have saved changes by using the Save method, the Microsoft Firewall service must be restarted for your change to take effect. You can use the RestartServices method of the FPCArray object (IFPCArray interface in C++) to stop and restart the Firewall service.

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

FPCCacheDrives


Send comments about this topic to Microsoft

Build date: 11/30/2009

 

© 2008 Microsoft Corporation. All rights reserved.