IMigrationLogObj::LogSuccess Method [C++]

Article
11/12/2009

Use this method when a successful migration occurs and the LogLevel registry key is 1 or 3. The success code is written to a file with a name constructed by concatenating the value of the LogFilePath registry key, the string "_success", and a number that is incremented as the file exceeds the "MaxNumLinesEachFile" registry key. An example file name is: C:\MigrationLogObj_success1.

Definition

[C++]

HRESULT IMigrationLogObj::LogSuccess(BSTRbstrKeyName,
  longlprofile_id);

[Visual Basic]

Sub LogSuccess(bstrKeyName As String,
  lprofile_id As Long)

Parameters

bstrKeyName[C++]
[in] A BSTR that contains the name of the object that is being migrated.
bstrKeyName[Visual Basic]
A String that contains the name of the object that is being migrated.
lprofile_id[C++]
[in] A long that contains the ID of the profile XML file that is used when migrating the object.
lprofile_id[Visual Basic]
A long that contains the ID of the profile XML file that is used when migrating the object.

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

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

Share via