Export (0) Print
Expand All

IWSDDeviceHost::SignalEvent method

Notifies all subscribed clients that an event has occurred.

Syntax


HRESULT SignalEvent(
  [in]  LPCWSTR pszServiceId,
  [in]  const void *pBody,
  [in]  const WSD_OPERATION *pOperation
);

Parameters

pszServiceId [in]

The ID of the service that generates the event.

pBody [in]

The body of the event.

pOperation [in]

Reference to a WSD_OPERATION structure that specifies the operation.

Return value

Possible return values include, but are not limited to, the following:

Return codeDescription
S_OK

Method completed successfully.

E_FAIL

The host is not started. Call Start to start the device host.

E_INVALIDARG

pszServiceId is NULL, pOperation is NULL, the length in characters of pszServiceId exceeds WSD_MAX_TEXT_LENGTH (8192), there is no ResponseType structure associated with pOperation, or the service specified by pszServiceId is not subscribed to the event specified by the ResponseType member of pOperation.

 

Remarks

SignalEvent blocks until the event is sent to all clients. Since clients are contacted sequentially, it is possible that SignalEvent will block for a long time if any client responds slowly or is unreachable.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

WsdHost.h (include Wsdapi.h)

IDL

WsdHost.idl

DLL

Wsdapi.dll

See also

IWSDDeviceHost

 

 

Community Additions

ADD
Show:
© 2014 Microsoft