IFPCVendorParametersSets::Add method

Article
08/27/2012

Applies to: desktop apps only

The Add method creates a new FPCVendorParametersSet object in the collection and returns a reference to it.

Syntax

HRESULT Add(
  [in]            BSTR Id,
  [in, optional]  VARIANT_BOOL Encrypted,
  [in, optional]  VARIANT_BOOL EncryptionReadable,
  [out]           IFPCVendorParametersSet **ppNewSet
);

FPCVendorParametersSets.Add( _
  ByVal Id As String, _
  [ ByVal Encrypted As Boolean ], _
  [ ByVal EncryptionReadable As Boolean ], _
  ByRef ppNewSet As IFPCVendorParametersSet _
) As FPCVendorParametersSet

Parameters

Id [in]
Required. The string-formatted globally unique identifier (GUID) of the new vendor parameters set.

Encrypted [in, optional]

C++	A Boolean value that indicates whether data saved in the new FPCVendorParametersSet object will be encrypted. The default value is VARIANT_FALSE.
VB	A Boolean value that indicates whether data saved in the new FPCVendorParametersSet object will be encrypted. The default value is False.

EncryptionReadable [in, optional]

C++	When this Boolean value is set to VARIANT_TRUE, encrypted data saved in the new FPCVendorParametersSet object can be read by any user account. When it is set to VARIANT_FALSE, encrypted data can be read only by the Local Service account and the Network Service account. The default value is VARIANT_FALSE.
VB	When this Boolean value is set to True, encrypted data saved in the new FPCVendorParametersSet object can be read by any user account. When it is set to False, encrypted data can be read only by the Local Service account and the Network Service account in Windows Server 2008. The default value is False.

ppNewSet [out]
Address of an interface pointer that on return points to the new IFPCVendorParametersSet interface created.

Return value

C++

The method can return one of the following:

S_OK, indicating that the operation succeeded.
An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

VB

The method returns a reference to the FPCVendorParametersSet object added if the call is successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

The GUID supplied is formatted as a string in the form {12345678-1234-1234-1234-123456789abc}. Note the presence of the braces normally used with GUIDs.

If an FPCVendorParametersSet object is added with the Encrypted parameter set to True (VARIANT_TRUE in C++) and the EncryptionReadable parameter set to False (VARIANT_FALSE), only calls made under the Local Service account or the Network Service account in Windows Server 2008 will be able to read the data stored in the object.

Note When a user that has permission to access storage, but not to read the encrypted data, requests an FPCVendorParametersSet object that was created with these parameter settings, an empty FPCVendorParametersSet object is returned. Then, if that user makes changes to the object and saves it to persistent storage, the original FPCVendorParametersSet object will be overwritten, and only the data added by that user will be saved.

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