IFPCVendorParametersSet::AllNames property

Article
08/27/2012

Applies to: desktop apps only

The AllNames property gets the names of all the parameters in the set.

This property is read-only.

Syntax

HRESULT get_AllNames(
  VARIANT *pvItem
);

' Data type: Variant

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

Property value

Array of strings containing the names of all the parameters in the set.

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 Variant (VARIANT in C++).

Examples

The AllNames property stores a list of all the names of the parameters that have been defined through the Value property.

For example, the following lines of VBScript code use the Value property to store values for two user-defined parameters, x and y:

Dim vpSet  ' An FPCVendorParametersSet object
...
vpSet.Value("x") = 1
vpSet.Value("y") = 2
vpSet.Save

If the AllNames property is used now, it returns an array of strings containing the strings "x" and "y".

The following VBScript code uses the AllNames property to display the names and values of the parameters defined in the vendor parameters set.

Dim allNames   ' A Variant
Dim name       ' A String
Dim index      ' An Integer
...
allNames = vpSet.AllNames
index = 1
If(IsEmpty(allNames)) Then
    WScript.Echo "The vendor parameters set is empty."
Else
    For Each name In allNames
        WScript.Echo index & ". " & name & " = " & _
                     vpSet.Value(name)
        index = index + 1
    Next
End If

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

Share via