IMigrationReadObj::Initialize Method [C++]

Article
11/12/2009

Use this method to determine which attributes to read for a particular key based on the profile ID.

Definition

[C++]

HRESULT IMigrationRead::Initialize(longlNumProfiles,
  PROFILEProfile[],
  BSTRbstrModifyProgID);

[Visual Basic]

Sub Initialize(lNumProfiles As Long,
  Profile[] As PROFILE,
  bstrModifyProgID As String)

Parameters

lNumProfiles[C++]
[in] A long that contains the number of profile XML files that will be used for the migration.
lNumProfiles[Visual Basic]
A Long that contains the number of profile XML files that will be used for the migration.
Profile[][C++]
[in, size_is (numProfiles)] An array of PROFILE structures holding all the information from the XML profile files.
Profile[][Visual Basic]
An array of PROFILE structures holding all the information from the XML profile files.
bstrModifyProgID[C++]
[in] A BSTR that contains the modified ProgID.
bstrModifyProgID[Visual Basic]
A String that contains the modified ProgID.

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

This method takes as input an array of structures containing all the attributes for each profile ID and the connection to use.

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

Share via