ITfContext::GetSelection method

Syntax

HRESULT GetSelection(
  [in]  TfEditCookie ec,
  [in]  ULONG        ulIndex,
  [in]  ULONG        ulCount,
  [out] TF_SELECTION *pSelection,
  [out] ULONG        *pcFetched
);

Parameters

ec [in]

Contains an edit cookie that identifies the edit session. This is the value passed to ITfEditSession::DoEditSession.

ulIndex [in]

Specifies the zero-based index of the first selection to obtain. Use TF_DEFAULT_SELECTION to obtain the default selection. If TF_DEFAULT_SELECTION is used, only one selection is obtained.

ulCount [in]

Specifies the maximum number of selections to obtain.

pSelection [out]

An array of TF_SELECTION structures that receives the data for each selection. The array must be able to hold at least ulCount elements.

pcFetched [out]

Pointer to a ULONG value that receives the number of selections obtained.

Return value

This method can return one of these values.

Remarks

A selection is a highlighted range of text, or an insertion point if the range is empty, that identifies the user focus area within a document.

If this method is successful, the caller must release the range member of all TF_SELECTION structures obtained.

Normally, a context only supports a single selection. It is possible, however, for a context to support multiple, simultaneous selections. This method can be used to obtain multiple selections.

Examples

HRESULT         hr;
TF_SELECTION    tfSel;
ULONG           uFetched;

//Obtain the default selection. 
hr = pContext->GetSelection(ec, TF_DEFAULT_SELECTION, 1, &tfSel, &uFetched);
if(SUCCEEDED(hr) && (uFetched > 0))
{
    //Work with the selection. 
    
    //Release the selection range object. 
    tfSel.range->Release();
}

Requirements

See also

ITfContext

ITfEditSession::DoEditSession

TF_SELECTION