BWYServerGetClientData Function

Overview

Get the previously set custom data associated with a client.

Declaration

LPVOID WINAPI BWYServerGetClientData(HANDLE hClient);

Parameters

  • hClient
    The client handle of the data to be retrieved.

Return Value

If the function succeeds and the client data was previously set by a call to BWYServerSetClientData the return value is that saved value. If the function fails or the client data was never set, the return value will be NULL.

Remarks

This function can be used to retrieve data previously set that would only be useful on a per client basis.

This function is not thread safe. It should therefore only be called from one of the various event callback functions. If it is necessary to call this function outside of the eventcall back functions, then you must wrap this function inside BWYServerLockClients and BWYServerUnlockClients.

Windows Requirements

HeaderBWYSystemsServer.h
LibraryBWYSystemsServer.lib
DLLBWYSystemsServer.dll

Linux Requirements

HeaderBWYSystemsServer.h
Shared LibrarylibBWYSystemsServer.so