prg_graph_state_ext_handler_register()
Abstract
Registers a set of extended client state handlers for a given namespace.
Syntax
prg_graph_state_ext_handler_register (namespace_name, state_name, destroy_proc, copy_proc)
| Argument | Type | Description |
|---|---|---|
namespace_name |
const char * |
The name of the namespace where you are registering the client state handlers |
state_name |
const char * |
User-defined information to be passed to the handlers |
destroy_proc |
PrgT_Graph_Ext_Destroy_Proc | The destroy procedure for the client state |
copy_proc |
PrgT_Graph_Ext_Copy_Proc | The copy procedure for the client state |
Return Type
PrgT_Graph_State_ID
The ID of the client state in relation to the namespace where it was registered; PRGC_GRAPH_INVALID_ID if there was a problem with the registration
Header
prg_graph.h
Details
The namespace is a container of the handler functions for the client state. The IDs that are assigned to the client state are unique within the namespace, but not across all namespaces.
The prototypes for the client state handlers are given in PrgT_Graph_Ext_Destroy_Proc and PrgT_Graph_Ext_Copy_Proc.