Difference between revisions of "ISInterface:ServiceBroadcast"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
Line 1: Line 1:
 +
===Syntax===
 +
*bool ServiceBroadcast(ISXInterface *pMaster, HISXSERVICE hService, unsigned long MSG, void *lpData)
 
== Purpose ==
 
== Purpose ==
 
+
Sending a message to all clients of this service
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===
 +
*ISXInterface *pMaster
 +
:'''[in]''' Pointer to the extension
 +
*HISXSERVICE hService
 +
:'''[in]''' Service handler returned by [[ISInterface:RegisterService|RegisterService]]
 +
*unsigned long MSG
 +
:'''[in]''' Service specific message number
 +
*void *lpData
 +
:'''[in]''' Data to be passed along with the message
 +
 
=== Return Value ===
 
=== Return Value ===
 +
*bool
 +
:Returns true on success, false on failure
 +
== Examples ==
  
== Examples ==
 
  
 
== See Also ==
 
== See Also ==
 
* [[ISXDK:ISInterface|ISInterface]]
 
* [[ISXDK:ISInterface|ISInterface]]
 +
* [[ISInterface:RegisterService|RegisterService]]
 +
* [[ISInterface:ServiceNotify|ServiceNotify]]
 +
* [[ISInterface:ShutdownService|ShutdownService]]
  
 
[[Category:ISXDK]]
 
[[Category:ISXDK]]
 
[[Category:ISInterface]]
 
[[Category:ISInterface]]

Latest revision as of 21:48, 2 September 2005

Syntax

  • bool ServiceBroadcast(ISXInterface *pMaster, HISXSERVICE hService, unsigned long MSG, void *lpData)

Purpose

Sending a message to all clients of this service

Usage

Parameters

  • ISXInterface *pMaster
[in] Pointer to the extension
  • HISXSERVICE hService
[in] Service handler returned by RegisterService
  • unsigned long MSG
[in] Service specific message number
  • void *lpData
[in] Data to be passed along with the message

Return Value

  • bool
Returns true on success, false on failure

Examples

See Also