WsGetListenerProperty function

Retrieves a specified Listener object property. The property to retrieve is identified by a WS_LISTENER_PROPERTY_ID input parameter.

Syntax


HRESULT WINAPI  WsGetListenerProperty(
  _In_     WS_LISTENER*            listener,
  _In_     WS_LISTENER_PROPERTY_ID id,
           void*                   value,
  _In_     ULONG                   valueSize,
  _In_opt_ WS_ERROR*               error
);

Parameters

listener [in]

A pointer to the Listener object containing the desired property. This must be a valid WS_LISTENER that was returned from WsCreateListener.

id [in]

This is a WS_LISTENER_PROPERTY_ID enumerator value that identifies the desired property.

value

A reference to a location for storing the retrieved property value. The pointer must have an alignment compatible with the type of the property.

valueSize [in]

Represents the byte-length buffer size allocated by the caller to store the retrieved property value.

error [in, optional]

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Return codeDescription
E_INVALIDARG

The property id was not supported for this object or the specified buffer was not large enough for the value.

Other Errors

This function may return other errors not listed above.

 

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

WebServices.h

Library

WebServices.lib

DLL

WebServices.dll

 

 

Community Additions

ADD
Show: