FPCLog object
Applies to: desktop apps only
The FPCLog object is used to specify the logging configuration for a specific component. Forefront TMG generates logs for monitoring and analyzing the status of the following components:
- Web proxy logging.
- Microsoft Firewall service logging.
Each FPCLog object is an element of an FPCLogs collection.
.png "Ff825265.bkbutton(en-us,VS.85).png")
Click here to see the Forefront TMG object hierarchy.
Inheritance
This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.
Members
The FPCLog object has these types of members:
- Properties
Properties
The FPCLog object has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets a value from the FpcLoggingComponents enumerated type that specifies the component to which the logging configuration refers. |
|
| Read/write | Gets or sets a Boolean value that indicates whether old log files will be deleted to maintain the total log size below the maximum allowed value, or to maintain the amount of free disk space above the required minimum. |
|
| Read/write | Gets or sets a Boolean value that indicates whether connections are to be dropped when logging errors occur. |
|
| Read/write | Gets or sets a Boolean value that indicates whether logging is enabled. |
|
| Read/write | Gets or sets a Boolean value that indicates whether the lower limit on the free disk space is enforced. |
|
| Read/write | Gets or sets a Boolean value that indicates whether the upper limit on the total log size is enforced. |
|
| Read/write | Gets or sets the name of the Structured Query Language (SQL) data source. |
|
| Write-only | Sets the password for connecting to the SQL table. |
|
| Read/write | Gets or sets the name of the SQL table. |
|
| Read/write | Gets or sets the user name for connecting to the SQL table. |
|
| Read/write | Gets or sets a bitmask in which each bit specifies whether a particular log field is selected for logging. |
|
| Read/write | Gets or sets a string in which each character specifies whether a particular log field is selected for logging. |
|
| Read/write | Gets or sets the full path of the directory containing the text log files. |
|
| Read/write | Gets or sets a value from the FpcLogFileDirectoryType enumerated type that indicates the type of path specified for the log files. |
|
| Read/write | Gets or sets the number of days during which old log files will be retained. |
|
| Read/write | Gets or sets a Boolean value that indicates whether text log files will be compressed. |
|
| Read/write | Gets or sets a value from the FpcLogType enumerated type that specifies the type of log. |
|
| Read/write | Gets or sets the upper limit on the total amount of disk space used to store log files, in gigabytes. |
|
| Read/write | Gets or sets the lower limit on the amount of free disk space, in megabytes. |
|
| Read/write | Gets or sets a value from the FpcSQLAuthType enumerated type that specifies the type of authentication that will be used to connect to a SQL Server database. |
|
| Read/write | Gets or sets the name of the SQL Server database. |
|
| Read/write | Gets or sets a Boolean value that indicates whether a secure connection is to be used when logging to a SQL Server database. |
|
| Read/write | Gets or sets the name of the SQL Server computer. |
|
| Read/write | Gets or sets the SQL Server port number. |
Methods Inherited from FPCPersist
| Name | Description |
|---|---|
| CancelWaitForChanges | Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only). |
| CanImport | Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document. |
| Export | Writes the stored values of all of the object's properties to the specified XML document. |
| ExportToFile | Writes the stored values of all of the object's properties to the specified XML file. |
| GetServiceRestartMask | Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect. |
| Import | Copies the values of all of the object's properties from the specified XML document to persistent storage. |
| ImportFromFile | Copies the values of all of the object's properties from the specified XML file to persistent storage. |
| LoadDocProperties | Provides the XML document's properties so that you can know what information can be imported from the document. |
| Refresh | Reads the values of all of the object's properties from persistent storage, overwriting any changes that have not been saved. |
| Save | Writes the current values of all of the object's properties to persistent storage. |
| WaitForChanges | Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only). |
Properties Inherited from FPCPersist
| Name | Description |
|---|---|
| PersistentName | Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy. |
| VendorParameterSets | Gets an FPCVendorParametersSets object that can hold sets of custom data for extending the object. |
Interfaces for C++ Programming
This object implements the IFPCLog, IFPCEELog, and IFPCLog2 interfaces.
Requirements
Minimum supported client |
Windows Vista, None supported |
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 |
See also
Build date: 7/12/2010