Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

WTSQueryListenerConfig function

Retrieves configuration information for a Remote Desktop Services listener.

Syntax


BOOL WINAPI WTSQueryListenerConfig(
  _In_   HANDLE hServer,
  _In_   PVOID pReserved,
  _In_   DWORD Reserved,
  _In_   LPTSTR pListenerName,
  _Out_  PWTSLISTENERCONFIG pBuffer
);

Parameters

hServer [in]

A handle to an RD Session Host server. Always set this parameter to WTS_CURRENT_SERVER_HANDLE.

pReserved [in]

This parameter is reserved. Always set this parameter to NULL.

Reserved [in]

This parameter is reserved. Always set this parameter to zero.

pListenerName [in]

A pointer to a null-terminated string that contains the name of the listener to query.

pBuffer [out]

A pointer to a WTSLISTENERCONFIG structure that receives the retrieved listener configuration information.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, call the GetLastError function.

Remarks

This function does not retrieve the security descriptor for the listener. To retrieve the security descriptor, call the WTSGetListenerSecurity function.

Requirements

Minimum supported client

Windows 7

Minimum supported server

Windows Server 2008 R2

Header

Wtsapi32.h

Library

Wtsapi32.lib

DLL

Wtsapi32.dll

Unicode and ANSI names

WTSQueryListenerConfigW (Unicode) and WTSQueryListenerConfigA (ANSI)

See also

WTSGetListenerSecurity
WTSLISTENERCONFIG

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.