GetProfileDefinition Method

Retrieves a profile definition from the server.

Namespace:  Microsoft.CommerceServer.Profiles
Assembly:  Microsoft.CommerceServer.Profiles.CrossTierTypes (in Microsoft.CommerceServer.Profiles.CrossTierTypes.dll)

Syntax

'Declaration
Public Function GetProfileDefinition ( _
    profileType As String _
) As XmlElement
'Usage
Dim instance As ProfileManagementContext
Dim profileType As String
Dim returnValue As XmlElement

returnValue = instance.GetProfileDefinition(profileType)
public XmlElement GetProfileDefinition(
    string profileType
)
public:
XmlElement^ GetProfileDefinition(
    String^ profileType
)
public function GetProfileDefinition(
    profileType : String
) : XmlElement

Parameters

  • profileType
    Type: System..::.String
    The type of profile to retrieve (that is, UserObject, Address).

Return Value

Type: System.Xml..::.XmlElement
An XML element representing the profile definition in the system.

Exceptions

Exception Condition
ArgumentNullException

Any of the parameters provided is nullNothingnullptra null reference (Nothing in Visual Basic).

AuthenticationException

User has not been authenticated.

NotAuthorizedException

User is not authorized to perform this task.

DefinitionDoesNotExistException

The profile definition named in the profileXml does not exist.

Remarks

Retrieves XML representing the retrieved profile schema.

Permissions

See Also

Reference

ProfileManagementContext Class

ProfileManagementContext Members

Microsoft.CommerceServer.Profiles Namespace