IFPCAccounts::Item method

Applies to: desktop apps only

The Item method retrieves the requested FPCAccount object (IFPCAccount interface in C++) from the collection.

Syntax

HRESULT Item(
  [in]   VARIANT v,
  [out]  IFPCAccount **pItem
);
FPCAccounts.Item( _
  ByVal v As Variant, _
  ByRef pItem As IFPCAccount _
) As FPCAccount

Parameters

  • v [in]
    Required. Account name or one-based index of the object to retrieve. The account name can be specified in the domain\user-name format.

  • pItem [out]
    Address of an interface pointer that on return points to the IFPCAccount interface requested.

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

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

Remarks

The Index parameter can be either in the form of a one-based index or an account name specified in the domain\user-name format.

Examples

The following lines of Visual Basic code specify an account by name in the domain\user-name format.

Dim accounts As FPCAccounts
...
accounts.Item("africa\john")

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

FPCAccounts

 

 

Build date: 7/12/2010