IFPCEEDelegatedAdmins::AddWithType method

Applies to: desktop apps only

The AddWithType method creates a new FPCDelegatedAdmin object, sets its Type property, and returns a reference to it.

Syntax

HRESULT AddWithType(
  [in]   BSTR Account,
  [in]   BSTR Role,
  [in]   long DelegatedAdminType,
  [out]  IFPCDelegatedAdmin **ppNewDelegatedAdmin
);
FPCDelegatedAdmins.AddWithType( _
  ByVal Account As String, _
  ByVal Role As String, _
  ByVal DelegatedAdminType As Long, _
  ByRef ppNewDelegatedAdmin As IFPCDelegatedAdmin _
) As FPCDelegatedAdmin

Parameters

  • Account [in]

    C++ BSTR that specifies the security identifier (SID) or name of the user or group of users. An account name can be specified in Configuration_Storage_server_name\user_name format.
    VB String that specifies the security identifier (SID) or name of the user or group of users. An account name can be specified in Configuration_Storage_server_name\user_name format.
  • Role [in]

    C++ BSTR that specifies the administrative role that will be assigned to the user or group of users.
    VB String that specifies the administrative role that will be assigned to the user or group of users.
  • DelegatedAdminType [in]
    A 32-bit bitmask containing one bit flag from the FpcDelegatedAdminType enumerated type that specifies whether the user or group of users is identified by security identifier (SID) or by name. If the lowest significant bit (bit 0) is set in this parameter, the SID of the user or group of users must be specified in the Account parameter. If bit 1 is set, the account name of the user or group of users must be specified in the Account parameter.

  • ppNewDelegatedAdmin [out]
    Address of an interface pointer that on return points to the new IFPCDelegatedAdmin interface created.

Return value

C++

This 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

This method returns a reference to the FPCDelegatedAdmin object if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

If the lowest significant bit (bit 0) is set in the DelegatedAdminType parameter, the delegated administrator must be identified in the Account parameter by the SID of the user or group of users. If bit 1 is set, the delegated administrator must be identified by the account name of the user or group of users.

Active Directory accounts are identified by SID and can be used for accessing a Configuration Storage server and for monitoring. Local accounts created on a Forefront TMG computer are identified by name and can be used only for monitoring. For local accounts, mirrored accounts must also be created on each array member for intra-array communication.

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

FPCDelegatedAdmins

 

 

Build date: 7/12/2010