IFPCPrimaryRoute::Save method

Article
08/27/2012

Applies to: desktop apps only

The Save method recursively writes the current values of all properties of the object and its subobjects to persistent storage. It is important to remember that any changes made by scripts and programs will not be saved until after the Save method is called.

Syntax

HRESULT Save(
  [in, optional]  VARIANT_BOOL fResetRequiredServices,
  [in, optional]  VARIANT_BOOL fReloadConfiguration
);

FPCPrimaryRoute.Save( _
  [ ByVal fResetRequiredServices As Boolean ], _
  [ ByVal fReloadConfiguration As Boolean ] _
)

Parameters

fResetRequiredServices [in, optional]

C++	Boolean value that indicates whether to restart the services that need to be restarted for any of the changes saved to take effect. The default value is VARIANT_FALSE.
VB	Boolean value that indicates whether to restart the services that need to be restarted for any of the changes saved to take effect. The default value is False.

fReloadConfiguration [in, optional]

C++	This parameter is provided for compatibility with ISA Server. The default value is VARIANT_TRUE. In Forefront TMG, this parameter is ignored.
VB	This parameter is provided for compatibility with ISA Server. The default value is True. In Forefront TMG, this parameter is ignored.

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

Configuration changes are applied only after the new settings are written to persistent storage and reloaded to the services that use them. Most changes can be applied dynamically without restarting any services. However, some changes can take effect only after the Microsoft Firewall service is restarted. For more information, see Restarting Services After Configuration Changes.

Forefront TMG maintains a bitmask that specifies which services need to be started for currently unsaved changes to take effect. This bitmask can be retrieved by calling the GetServiceRestartMask method on an object that contains this object as a subobject. Calling the Save method clears all of the bits in this bitmask even if the fResetRequiredServices parameter is set to False (VARIANT_FALSE in C++).

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

Share via