AllNames Property of the IFPCVendorParametersSet Interface

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

C++

HRESULT get_AllNames(
    VARIANT* pvItem
);

Parameters

  • pvItem
    Pointer to a VARIANT that on return receives a safe array of strings containing the names of all the parameters in the set.

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 all the parameters in the set.

Example Code

,

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

Remarks

This property is read-only. Its default value is an empty Variant (VARIANT in C++).

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.

See Also

FPCVendorParametersSet

Send comments about this topic to Microsoft

Build date: 6/30/2010