Share via

IMAExtensibleCallExport.BeginExport Method

  • Article

Called at the start of an export run to connect to the connected directory and other resources.

Namespace: Microsoft.MetadirectoryServices
Assembly: Microsoft.MetadirectoryServicesEx (in Microsoft.MetadirectoryServicesEx.dll)

Usage

'Usage
Dim instance As IMAExtensibleCallExport
Dim connectTo As String
Dim user As String
Dim password As String
Dim configParameters As ConfigParameterCollection
Dim types As TypeDescriptionCollection

instance.BeginExport(connectTo, user, password, configParameters, types)

Syntax

'Declaration
Sub BeginExport ( _
    connectTo As String, _
    user As String, _
    password As String, _
    configParameters As ConfigParameterCollection, _
    types As TypeDescriptionCollection _
)

void BeginExport (
    string connectTo,
    string user,
    string password,
    ConfigParameterCollection configParameters,
    TypeDescriptionCollection types
)

void BeginExport (
    String^ connectTo, 
    String^ user, 
    String^ password, 
    ConfigParameterCollection^ configParameters, 
    TypeDescriptionCollection^ types
)

void BeginExport (
    String connectTo, 
    String user, 
    String password, 
    ConfigParameterCollection configParameters, 
    TypeDescriptionCollection types
)

function BeginExport (
    connectTo : String, 
    user : String, 
    password : String, 
    configParameters : ConfigParameterCollection, 
    types : TypeDescriptionCollection
)

Parameters

  • connectTo
    The name of the connected directory. This value comes from the Connect To text box of the Configure Connection Information dialog box of the extensible connectivity management agent properties.
  • user
    The user name of the account that has the appropriate privileges for the connected directory. This value comes from the User text box of the Configure Connection Information dialog box in the extensible connectivity management agent properties.
  • password
    The password of the account that has the appropriate privileges for the connected directory. This value comes from the Password text box of the Configure Connection Information dialog box in the extensible connectivity management agent properties.
  • configParameters
    The parameters and values that are configured in the Configure Additional Parameters dialog box of the extensible connectivity management agent properties.

Exceptions

Exception type Condition
BadServerCredentialsException

The credentials that are used to connect to the connected directory are not valid. When this method throws this exception, the run stops and the Windows Management Instrumentation (WMI) Provider returns the string stopped-bad-server-credentials.

This exception does not generate an event log entry.
EntryPointNotImplementedException

The rules extension does not implement this method. When this method throws this exception, the run stops and the WMI Provider returns the string stopped-entry-point-not-implemented.

This exception does not generate an event log entry.
ExtensibleExtensionException

An unexpected error occurs in the extension. When this method throws this exception, the run stops and the WMI Provider returns the string stopped-extensible-extension-error.

This exception generates an event log entry.
ServerDownException

The connected directory extension cannot establish a connection to the connected directory. When this method throws this exception, the run stops and the WMI Provider returns the string stopped-server-down.

This exception does not generate an event log entry.
UnexpectedDataException

The method received unexpected data. When this method throws this exception, the run stops and the WMI Provider returns the string stopped-unexpected-data.

This exception generates an event log entry.

Remarks

Implement this method in all types of call-based connected data source extensions. Although this method is not called from import-only connected data source extensions, an error occurs if this method is not implemented in the extension. For an import-only connected data source extension, you can implement this method by throwing an EntryPointNotImplementedException exception.

All the exceptions that are described in this topic stop a run. If the method throws an exception that is not described in this topic, the run continues. If the run stops, the WMI Provider returns the string stopped-extension-dll-exception and generates an event log entry.

All data in Forefront Identity Manager Synchronization Service (FIM Synchronization Service) uses the Unicode character set. If the connected data source that receives the exported data requires data in a different character set, use this method to convert the Unicode data to the character set that is required by your connected data source.

The ExportEntry method is called if this method does not throw an exception. When an exception is thrown, the EndExport method is then called.

If the BeginExport method throws an exception, the EndExport method is called to release the resources and disconnect the directory. However, when the thread becomes blocked or deadlocked, it is not possible to call EndExport. In this case, FIM Synchronization Service terminates the extensions.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003 , Windows Server 2008, and Windows 2000

Target Platforms

See Also

Reference

IMAExtensibleCallExport Interface
IMAExtensibleCallExport Members
Microsoft.MetadirectoryServices Namespace
ConfigParameterCollection
ExportEntry
EndExport
TypeDescriptionCollection
IMAExtensibleCallExport