ProfileService.CreateProfileXML Method (PIA)

Article
11/12/2009

Use this method to create a ProfileObject object using XML data.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Profiles
…
Public Function CreateProfileXML(sValue AsObject,
  ByValbstrProfileTypeAsString,
  ByValbstrProfileXMLAsSring,
  eXMLFormatAsXMLFormatEnum,bAttributeCentricAsBoolean,) As ProfileObject

[C#]

using Microsoft.CommerceServer.Interop.Profiles;
…
public ProfileObject CreateProfileXML(objectsValue,
  stringbstrProfileType,
  string bstrProfileXML,XMLFormatEnum eXMLFormat);

Parameters

[Visual Basic .NET]

sValue
[in] An Object that contains the primary key value for the new ProfileObject object.
bstrProfileType
A String that contains the profile type.
bstrProfileXML
A String that contains the profile properties in XML.
eXMLFormat
An XMLFormatEnum enumeration that contains the XML format. See the Remarks section for allowed values.

[C#]

sValue
[in] An Object that contains the primary key value for the new ProfileObject object.
bstrProfileType
[in] A String that contains the profile type.
bstrProfileXML
[in] A String that contains the profile properties in XML.
eXMLFormat
[in] An XMLFormatEnum that contains the XML format. See the Remarks section for allowed values.

Return Values

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

[Visual Basic .NET] If this method completes successfully, it returns the newly created ProfileObject object. The object is set to **Nothing****if a ProfileObject object of the specified primary key and schema type already exists in the Profiles store.

Error Values

The Errors property stores the collection of errors encountered in the last Profiles resource operation. For more information, see IProfileService::get_Errors.

Remarks

If the CreateProfile method fails on an aggregated profile (one that has multiple data sources), the DeleteProfile method must be called to clean up any entries in the data stores. In this case, the DeleteProfile method will produce an error that should be ignored.

Call the Update method on the returned ProfileObject object to commit the new profile to the data store. The Update method will verify that a ProfileObject object with the specified attributes does not already exist in the database.

The Fields property of the returned ProfileObject object provides access to the profile properties.

Use the GetProfile or GetProfileByKey method to retrieve existing ProfileObject instances from the Profiles store.

Call the Initialize method before you use this ProfileService method.

The following table shows the values in the XMLFormatEnum enumeration, their associated names, and describes their use.

Name	Value	Description
EInvalid	0	Reserved for future use.
eAttributeCentric	1	Attribute-centric XML format.
eElementCentric	2	Element-centric XML format.

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

Requirements

Namespace: Microsoft.CommerceServer.Interop.Profiles

Platforms: Windows 2000, Windows Server 2003

Assembly: mscsupslib (in mscsupslib.dll)