Función WsGetChannelProperty (webservices.h)

Artículo
08/27/2023

Recupera una propiedad del canal al que hace referencia el parámetro channel .

Sintaxis

HRESULT WsGetChannelProperty(
  [in]           WS_CHANNEL             *channel,
  [in]           WS_CHANNEL_PROPERTY_ID id,
                 void                   *value,
  [in]           ULONG                  valueSize,
  [in, optional] WS_ERROR               *error
);

Parámetros

[in] channel

Puntero al objeto WS_CHANNEL con la propiedad que se va a recuperar.

[in] id

Representa un identificador de la propiedad que se va a recuperar.

value

Puntero void que hace referencia a la ubicación para almacenar la propiedad recuperada.

Nota El puntero debe tener una alineación compatible con el tipo de la propiedad .

[in] valueSize

Número de bytes asignados por el autor de la llamada para almacenar la propiedad recuperada.

[in, optional] error

Puntero a un objeto WS_ERROR donde se debe almacenar información adicional sobre el error si se produce un error en la función.

Valor devuelto

Esta función puede devolver uno de estos valores.

Código devuelto	Descripción
E_INVALIDARG	El identificador de propiedad no se admite para este objeto o el búfer especificado no era lo suficientemente grande.
E_OUTOFMEMORY	Se quedó sin memoria.
Otros errores	Esta función puede devolver otros errores no enumerados anteriormente.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7 [aplicaciones de escritorio \| Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 R2 [aplicaciones de escritorio \| Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	webservices.h
Library	WebServices.lib
Archivo DLL	WebServices.dll