AllNames Property of the IFPCClientSettingsSection Interface

Article
08/13/2010

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

C++

HRESULT get_AllNames(
    VARIANT* pItem
);

Parameters

pItem
Pointer to a VARIANT that on return receives a safe array of strings containing the names of the keys of all the entries in the Forefront TMG Client settings section.

Return Value

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

Visual Basic

Property AllNames As Variant

Property Value

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

Example Code

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

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.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.

Share via