IProfileObject::GetProfileXML

Ee783662.c++_off(en-US,CS.10).gifEe783662.vb_on(en-US,CS.10).gif

Use this method to retrieve the XML schema and data of the profile object.

Definition

HRESULT IProfileObject::GetProfileXML(XMLRetrieveEnumeRetrieveEnum,VARIANT_BOOLbAttributeCentric,BSTR*pbstrXML);

Parameters

bAttributeCentric

[in] A VARIANT_BOOL that indicates the XML output format. Set this parameter to True (1) to retrieve the XML in an attribute-centric format, and to False (0) to retrieve the XML in an element-centric format.

pbstrXML

[out, retval] A pointer to a BSTR that contains the resulting XML fragment.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

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

Remarks

The pbstrXML parameter contains valid data only if the method completes successfully.

The following table defines the possible values for XMLRetrieveEnum.

Name Value Description
psRetrieveInvalidValue 0 Invalid option
psRetrieveSchemaAndData 1 Both the schema and data are retrieved.
psRetrieveDataOnly 2 Only the data is retrieved.
psRetrieveSchemaOnly 3 Only the schema is retrieved.

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

See Also

ProfileObject Object

IProfileObject::get_Fields

Profile XML Structures


All rights reserved.