IMigrationMainObj::MigrateObject Method [C++]

Article
11/12/2009

Use this method to migrate an ADSPath key to the Commerce Server 2002 Enterprise Editon (EE) Profile data store. This method is called from the Active Server Pages (ASP) page or from Microsoft Visual Basic Scripting Edition (VBscript).

Definition

[C++]

HRESULT IMigrationMainObj::MigrateObject(BSTRbstrKeyName,
  longlProfile_id);

[Visual Basic]

Sub MigrateObject(bstrKeyName As String,
  lProfile_id As Long)

Parameters

bstrKeyName[C++]
[in] A BSTR that contains the ADSPath key.
bstrKeyName[Visual Basic]
A String that contains the ADSPath key.
lProfile_id[C++]
[in] A long that contains the profile ID to be used for the ADSPath key.
lProfile_id[Visual Basic]
A Long that contains the profile ID to be used for the ADSPath key.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] None.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

The MigrationProfile object finds the appropriate attribute array for the input profile ID to be filled in by the MigrationReadObj object. This array, along with the key (ADSPath) and profile ID is then passed to the MigrationReadObj, MigrationModifyObj, or MigrationWriteObj objects to be processed.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

Share via