Share via


ProfileService.GetProfileDefXML

Ee799189.c++_on(en-US,CS.10).gifEe799189.vb_off(en-US,CS.10).gif

Use this method to retrieve the XML definition of the named profile schema type.

Definition

Function GetProfileDefXML(bstrProfileName As StringbNamesOnlyAs Boolean,) As String

Parameters

bstrProfileName

[in] A String that contains the name of the profile schema type.

bNamesOnly

[in] A Boolean that determines whether the method returns the profile schema name or the profile schema definition. A value of FALSE indicates to return the profile definition. A value of TRUE indicates to return only the name of the profile schema.

Return Values

If this method completes successfully, it returns a String that contains the XML description.

Error Values

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

Remarks

If the bstrProfileName parameter is empty and the bNamesOnly parameter is False (0), the XML descriptions of all the schema types in the catalog are returned.

If the bstrProfileName parameter is empty and the bNamesOnly parameter is True (-1), the names of all the schema types in the catalog are returned.

For information about the XML definitions, see the Profile XML Structures topic.

Call the Initialize method before you use this ProfileService method.

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

Example

' sXML is a String
' oProfileService is a Commerce ProfileService object

sXML = oProfileService.GetProfileDefXML("UserObject", False)

See Also

ProfileService Object

Profile XML Structures


All rights reserved.