IFPCClientSettingsSection::Value property

Article
08/27/2012

Applies to: desktop apps only

The Value property gets or sets the value associated with the specified key.

This property is read/write.

Syntax

HRESULT put_Value(
  BSTR Name,
  BSTR newVal
);

HRESULT get_Value(
  BSTR Name,
  BSTR *pVal
);

' Data type: String

Property Value( _
  ByVal Name As String, _
  ByVal Name As BSTR, _
  ByVal pVal As BSTR, _
  ByVal newVal As BSTR _
) As String

Property value

String associated with the key specified by the Name parameter.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write.

The FPCClientSettingsSection object is used to store data that is defined as {key, value} pairs using the Value property.

The following table lists the keys and values that can be used in entries that may be included in a Forefront TMG Client settings section for a specific client application. The first column lists the keys, and the second column describes the values to which the keys can be set.

Key	Value
ControlChannel	Possible values: Wsp.udp or Wsp.tcp (default). Specifies the type of control channel used.
Disable	Possible values: 0 or 1. When the value is set to 1, Forefront TMG Client or Firewall Client is disabled for the specific client application.
DisableEx	Possible values: 0 or 1. When the value is set to 1, Firewall Client is disabled for the specific client application. Applies only to Firewall Client for ISA Server 2004. When this entry is included, it overrides the Disable entry.
DontRemoteOutboundTcpPorts	Specifies an outbound TCP port, list, or range that is bound locally.
DontRemoteOutboundUdpPorts	Specifies an outbound UDP port, list, or range that is bound locally.
EnableRouteMode	Possible values: 0 or 1 (default). When the value is set to 1 and a routing relationship is configured between the Forefront TMG Client or Firewall Client computer and the requested destination, the IP address of the Forefront TMG Client or Firewall Client computer is used as the source address. When the value is set to 0, the IP address of the Forefront TMG computer is used.
LocalBindTcpPorts	Specifies a TCP port, list, or range that is bound locally.
LocalBindUdpPorts	Specifies a UDP port, list, or range that is bound locally.
NameResolution	Possible values: L or R. By default, dotted domain names are redirected to the Forefront TMG computer for name resolution, and all other names are resolved on the local computer. When the value is set to R, all names are redirected to the Forefront TMG computer for resolution. When the value is set to L, all names are resolved on the local computer.
NameResolutionForLocalHost	Possible values: L (default), P, or E. Specifies how the client computer name is resolved in calls to the Winsock gethostbyname function with the argument set to the string LocalHost, an empty string, or a NULL string pointer. When this option is set to L, gethostbyname returns the IP addresses of the client computer. When the value is set to P, gethostbyname returns the IP addresses of the Forefront TMG computer. When the value is set to E, gethostbyname returns only the IP addresses of the Forefront TMG computer that are not in the network where the client resides.
Persistent	Possible values: 0 or 1. When the value is set to 1, a specific server state can be maintained on the Forefront TMG computer if a service is stopped and restarted and if the server is not responding. The client sends a keep-alive message to the server periodically during an active session. If the server is not responding, the client tries to restore the state of the bound and listening sockets upon server restart.
RemoteBindTcpPorts	Specifies a TCP port, list, or range that is bound remotely.
RemoteBindUdpPorts	Specifies a UDP port, list, or range that is bound remotely.
ServerBindTcpPorts	Specifies a TCP port, list, or range for all ports that should accept more than one connection.

Examples

The following Visual Basic code stores an entry that has the key x and a value of 1.

The expression "Value("x")" will return the value.

Dim root As New FPCLib.FPC
Dim settingsSection As FPCClientSettingsSection
...
settingsSection.Value("x") = "1"

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