Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

WTSSetRenderHint function

Used by an application that is displaying content that can be optimized for displaying in a remote session to identify the region of a window that is the actual content.

In the remote session, this content will be encoded, sent to the client, then decoded and displayed.

Syntax


HRESULT WINAPI WTSSetRenderHint(
  _Inout_ UINT64 *pRenderHintID,
  _In_    HWND   hwndOwner,
  _In_    DWORD  renderHintType,
  _In_    DWORD  cbHintDataLength,
  _In_    BYTE   *pHintData
);

Parameters

pRenderHintID [in, out]

The address of a value that identifies the rendering hint affected by this call. If a new hint is being created, this value must contain zero. This function will return a unique rendering hint identifier which is used for subsequent calls, such as clearing the hint.

hwndOwner [in]

The handle of window linked to lifetime of the rendering hint. This window is used in situations where a hint target is removed without the hint being explicitly cleared.

renderHintType [in]

Specifies the type of hint represented by this call.

ValueMeaning
RENDER_HINT_CLEAR
0

The previous hint is cleared.

pHintData must be NULL.

RENDER_HINT_VIDEO
1

Indicates the presence of moving video.

pHintData contains a RECT structure which specifies the coordinates and size of the rendering area. These coordinates are relative to the client coordinates of the window represented by the hwndOwner parameter.

RENDER_HINT_MAPPEDWINDOW
2

Indicates the presence of a window mapping.

pHintData contains a RECT structure which specifies the coordinates and size of the rendering area. These coordinates are relative to the client coordinates of the window represented by the hwndOwner parameter.

 

cbHintDataLength [in]

The size, in BYTEs, of the pHintData buffer.

pHintData [in]

Additional data for the hint.

The format of this data is dependent upon the value passed in the renderHintType parameter.

Return value

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

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Header

Wtshintapi.h

Library

Wtsapi32.lib

DLL

Wtsapi32.dll

 

 

Show:
© 2015 Microsoft