RetrieveAllEntitiesRequest.RetrieveAsIfPublished Property

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Gets or sets whether to retrieve the metadata that has not been published. Required.

Namespace: Microsoft.Xrm.Sdk.Messages
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

'Declaration
Public Property RetrieveAsIfPublished As Boolean

public bool RetrieveAsIfPublished { get; set; }

Property Value

Type: Boolean
true if the metadata that has not been published should be retrieved; otherwise, false.

Remarks

If you are creating an entity editor you will need to retrieve entity data that has been saved but not published. For other scenarios you will want to only retrieve published metadata.

Set this value to true to include unpublished changes, as it would look if you called publish.
Set this value to false to include only the currently published changes, ignoring the changes that haven't yet been published.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Share via