Remove Method of the IFPCNonWindowsUsers Interface

The Remove method removes the specified FPCNonWindowsUser object from the collection. You can specify the object either by its namespace and user name, or by its one-based index.

C++

Syntax

HRESULT Remove(
  [in]            VARIANT IndexOrUsername,
  [in, optional]  BSTR Namespace
);

Parameters

  • IndexOrUsername
    Required. One-based index or user name of the object to retrieve.

  • Namespace
    BSTR that specifies the authentication namespace for the non-Windows user. This parameter must be specified when you provide a user name in the IndexOrUsername parameter. The default value is an empty BSTR.

Return Value

This method returns S_OK if the call is successful; otherwise, it returns an error code.

Visual Basic

Syntax

Sub Remove( _
  ByVal IndexOrUsername As Variant, _
  [ ByVal Namespace As String ] _
)

Parameters

  • IndexOrUsername
    Required. One-based index or user name of the object to retrieve.

  • Namespace
    String that specifies the authentication namespace for the non-Windows user. This parameter must be specified when you provide a user name in the IndexOrUsername parameter. The default value is an empty string.

Return Value

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

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

FPCNonWindowsUsers

Send comments about this topic to Microsoft

Build date: 6/30/2010