Microsoft Internet Security and Acceleration Server 2004 SDK

IFPCPersist::Save[C++]

FPCPersist.Save [Visual Basic]

[C++]

The Save method recursively writes all of the properties of the object and its subobjects to persistent storage. For a collection, the method also writes all of its elements and their properties to persistent storage. It is important to remember that any changes made by scripts and programs are not saved until after the Save method is called.

HRESULT Save(
  VARIANT_BOOL fResetRequiredServices,
  VARIANT_BOOL fReloadConfiguration
);

Parameters

fResetRequiredServices
[in, optional] 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.
fReloadConfiguration
[in, optional] Boolean value that indicates whether the call will include synchronous reloading of all changes that can be applied dynamically without restarting services. The default value is VARIANT_TRUE.

Return Values

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

Remarks

Configuration changes are applied only when the new values are reloaded to the services that use them. Most changes can be applied dynamically without restarting any services. However, changes to the properties in the following table and configuration changes caused by calls to the methods in this table can take effect only after the Microsoft Firewall service is restarted:

Object Property or method
FPCApplicationFilter Enabled
FPCAttackDetection IpRoutingEnabled
FPCCacheConfiguration MemoryUsagePercentage
FPCCacheDrive CacheLimitInMegs
FPCLowLevelSettings All properties
FPCTunnelPortRange TunnelLowPort
TunnelHighPort
FPCTunnelPortRanges AddRange
Remove
FPCWebProxy All properties

ISA Server maintains a bitmask that specifies which services need to be started for any of the currently unsaved changes to take effect. The bitmask for the current object and its subobject can be retrieved by calling the GetServiceRestartMask method. Calling the Save method clears all of the bits in this bitmask even if the fResetRequiredServices parameter is set to VARIANT_FALSE.

If the fReloadConfiguration parameter is set to VARIANT_FALSE the current values of the object's properties will be written to persistent storage without updating the configuration being used by the ISA Server services. The configuration used by each service will not be updated until the service is restartedor the new settings are reloaded by another call to Save.

[Visual Basic]

The Save method recursively writes all of the properties of the object and its subobjects to persistent storage. For a collection, the method also writes all of its elements and their properties to persistent storage. It is important to remember that any changes made by scripts and programs are not saved until after the Save method is called.

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

Parameters

fResetRequiredServices
[in, optional] 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] Boolean value that indicates whether the call will include synchronous reloading of all the saved configuration changes that can be applied dynamically without restarting services. The default value is True.

Return Values

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 when the new values are reloaded to the services that use them. Most changes can be applied dynamically without restarting any services. However, changes to the properties in the following table and configuration changes caused by calls to the methods in this table can take effect only after the Microsoft Firewall service is restarted:

Object Property or method
FPCApplicationFilter Enabled
FPCAttackDetection IpRoutingEnabled
FPCCacheConfiguration MemoryUsagePercentage
FPCCacheDrive CacheLimitInMegs
FPCLowLevelSettings All properties
FPCTunnelPortRange TunnelLowPort
TunnelHighPort
FPCTunnelPortRanges AddRange
Remove
FPCWebProxy All properties

ISA Server maintains a bitmask that specifies which services need to be started for any of the currently unsaved changes to take effect. The bitmask for the current object and its subobject can be retrieved by calling the GetServiceRestartMask method. Calling the Save method clears all of the bits in this bitmask even if the fResetRequiredServices parameter is set to False.

If the fReloadConfiguration parameter is set to False the current values of the object's properties will be written to persistent storage without updating the configuration being used by the ISA Server services. The configuration used by each service will not be updated until the service is restarted or the new settings are reloaded by another call to Save.

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPCPersist