ImageComparer.Compare Method (Image, Image, Image%)

Compares two images to check whether they are the same, and calculates the difference between the two images as a diff image.

Namespace:  Microsoft.VisualStudio.TestTools.UITesting
Assembly:  Microsoft.VisualStudio.TestTools.UITesting (in Microsoft.VisualStudio.TestTools.UITesting.dll)

Syntax

'Declaration
Public Shared Function Compare ( _
    actualImage As Image, _
    expectedImage As Image, _
    <OutAttribute> ByRef diffImage As Image _
) As Boolean

public static bool Compare(
    Image actualImage,
    Image expectedImage,
    out Image diffImage
)

public:
static bool Compare(
    Image^ actualImage, 
    Image^ expectedImage, 
    [OutAttribute] Image^% diffImage
)

static member Compare : 
        actualImage:Image * 
        expectedImage:Image * 
        diffImage:Image byref -> bool

public static function Compare(
    actualImage : Image, 
    expectedImage : Image, 
    diffImage : Image
) : boolean

Parameters

• actualImage
  Type: Image

  Actual image.

• expectedImage
  Type: Image

  Expected image.

• diffImage
  Type: Image%

  An image whose argb values represent the difference between the two images.

Return Value

Type: Boolean
True if the two images are the same.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

ImageComparer Class

Compare Overload

Microsoft.VisualStudio.TestTools.UITesting Namespace