IFPCCacheDrives::Add method

Applies to: desktop apps only

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.

Syntax


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

Parameters

Name [in]
C++Required. BSTR that specifies the name of the new cache drive, such as "C:".
VBRequired. String that specifies the name of the new cache drive, such as "C:".
CacheLimitInMegs [in]

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

ppNewCacheDrive [out]

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

Return value

C++

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

VB

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

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

FPCCacheDrives

 

 

Build date: 7/12/2010

Show: