IsPrimary method

  • Article

Determines whether the control element represented by this segment is the primary element of a multi-element selection.

Syntax

HRESULT retVal = object.IsPrimary(pfPrimary);

Parameters

  • pfPrimary [out]
    Type: BOOL

    Pointer to a BOOL that receives TRUE if the element is the primary element, or FALSE otherwise.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The primary element of a multiple selection is typically the first one a user chose when making the selection. The primary element typically has distinctive handles that indicate it is the primary element (for example, it might have white handles while all the other selected elements have black ones).

You might, for example, use the primary element as the reference point for an aligning operation.