IMigrationLogObj::Initialize Method [C++]

Article
11/12/2009

Use this method to initialize the MigrationLogObj object.

Definition

[C++]

HRESULT IMigrationLogObj::Initialize(intnLogSuccess);

[Visual Basic]

Sub Initialize(nLogSuccess As int)

Parameters

nLogSuccess[C++]
[in] An int that indicates which migrations will be written to the log file. A value of 1 (one) means that successful migrations will be written to the log file as well as unsuccessful migrations. A value of 0 (zero) means that only unsuccessful migrations will be written.
nLogSuccess[Visual Basic]
An int that indicates which migrations will be written to the log file. A value of 1 (one) means that successful migrations will be written to the log file as well as unsuccessful migrations. A value of 0 (zero) means that only unsuccessful migrations will be written.

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

Call this method before calling the RecordInfo or LogSuccess methods.

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

[C++] Requirements for using this method are listed in MigrationLogObj Object.

[Visual Basic] Requirements for using this method are listed in MigrationLogObj Object.

Share via