IFPCClientSettingsSection::AllNames property

Applies to: desktop apps only

The AllNames property gets the names of the keys of all the entries in the Forefront TMG Client settings section.

This property is read-only.

Syntax

HRESULT get_AllNames(
  VARIANT *pItem
);
' Data type: Variant

Property AllNames( _
  ByVal pItem As VARIANT _
) As Variant

Property value

Array of strings containing the names of the keys of all the entries in the Forefront TMG Client settings section.

Error codes

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

Remarks

This property is read-only. Its default value is an empty array of strings.

The AllNames property retrieves a safe array of all the keys in the Forefront TMG Client settings section. New entries are added in the form of {key, value} pairs by using the Value property, and entries are removed by calling the RemoveValue method.

Examples

This VBScript script displays all the sections of Forefront TMG Client settings for an array. It does not include error handling.

' Create the root object.
Dim root  ' The FPCLib.FPC root object
Set root = CreateObject("FPC.Root")
' Declare the other objects needed.
Dim isaArray               ' An FPCArray object
Dim clientConfigSettings   ' An FPCClientConfigSettings collection
Dim clientSettingsSection  ' An FPCClientSettingsSection object
Dim allNames               ' A Variant
Dim name                   ' A String
Dim index                  ' An Integer
' Get references to the array object and the 
' Forefront TMG Client configuration settings collection.
Set isaArray = root.GetContainingArray()
Set clientConfigSettings = isaArray.FWClientConfigSettings
' Display the sections of Forefront TMG Client settings
' for the array.
For Each clientSettingsSection In clientConfigSettings
    WScript.Echo "[" & clientSettingsSection.Name & "]"
    allNames = clientSettingsSection.AllNames
    For Each name In allNames
        WScript.Echo name & "=" & clientSettingsSection.Value(name)
    Next
    WScript.Echo vbCrLf
Next

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

FPCClientSettingsSection

 

 

Build date: 7/12/2010