IMigrationReadObj::ReadAttributes Method [C++]

Article
11/12/2009

Use this method to determine what attributes are associated with the key, and then read these attributes from the data source into the array.

Definition

[C++]

HRESULT IMigrationReadObj::ReadAttributes(BSTRbstrKeyName,
  longlProfile_id,
  SAFEARRAY(VARIANT)*AttributeStructure,
  VARIANT*varValueIndex,
  VARIANT*vMemberOfs);

[Visual Basic]

Sub ReadAttributes(bstrKeyName As String,
  lProfile_id As Long,
  AttributeStructure As SAFEARRAY(VARIANT),
  varValueIndex As Variant,
  vMemberOfs As Variant)

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 been used.
lProfile_id[Visual Basic]
A Long that contains the ID of the profile XML file that is been used.
AttributeStructure[C++]
[out] A reference to a SAFEARRAY(VARIANT) that contains an array of all the attributes that are to be migrated for this object.
AttributeStructure[Visual Basic]
A SAFEARRAY(VARIANT) that contains an array of all the attributes that are to be migrated for this object.
varValueIndex[C++]
[in] A pointer to a VARIANT array showing which attributes were actually read for this object. If an index is Null, then this object did not have this attribute set.
varValueIndex[Visual Basic]
A VARIANT array showing which attributes were actually read for this object. If an index is Null, then this object did not have this attribute set.
vMemberOfs[C++]
[out] A pointer to a VARIANT array containing all the groups to which this object is a member.
vMemberOfs[Visual Basic]
A Variant array containing all the groups to which this object is a member.

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 is called for each migration that takes place.

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

Share via