kFireSync/html/k_actions_8h_source.html

 #ifndef K_FIRESYNC_ACTIONS_H

 #define K_FIRESYNC_ACTIONS_H


 #include <kFireSync/kNodeDef.h>


 //typedef kObject kActions;        --forward-declared in kFsDef.x.h


 kFsFx(kSize) kActions_TypeCount(kActions actions);


 kFsFx(const kChar*) kActions_TypeNameAt(kActions actions, kSize index);


 kFsFx(const kChar*) kActions_TypeDescriptionAt(kActions actions, kSize index);


 kFsFx(kStatus) kActions_Clear(kActions actions);


 kFsFx(kStatus) kActions_AddAction(kActions actions, const kChar* typeName, const kChar* name, kAction* action);


 kFsFx(kStatus) kActions_DeleteAction(kActions actions, kAction action);


 kFsFx(kStatus) kActions_FindAction(kActions actions, const kChar* name, kAction* action);


 kFsFx(kSize) kActions_ActionCount(kActions actions);


 kFsFx(kAction) kActions_ActionAt(kActions actions, kSize index);


 kFsFx(kStatus) kActions_Invoke(kActions actions, const kChar* typeName, kXml config, kObject input, kObject* output, kAlloc alloc);


 kFsFx(kStatus) kActions_InvokeAndSync(kActions actions, const kChar* typeName, kXml config, kObject input, kObject* output, kAlloc alloc);


 #include <kFireSync/Client/kActions.x.h>


 #endif

kActions::kActions_InvokeAndSync
kStatus kActions_InvokeAndSync(kActions actions, const kChar *typeName, kXml config, kObject input, kObject *output, kAlloc alloc)
Applies current setting to the node and invokes an action of the given type.

kActions::kActions_AddAction
kStatus kActions_AddAction(kActions actions, const kChar *typeName, const kChar *name, kAction *action)
Creates and adds a new action to the actions collection.

kActions::kActions_TypeNameAt
const kChar * kActions_TypeNameAt(kActions actions, kSize index)
Gets the name of the action type at the specified index.

kSize

kAlloc

kChar

kNodeDef.h
Essential declarations related to FireSync nodes.

kAction
Represents action configuration.

kActions::kActions_TypeCount
kSize kActions_TypeCount(kActions actions)
Gets the number of action types currently available on this node.

kActions::kActions_Invoke
kStatus kActions_Invoke(kActions actions, const kChar *typeName, kXml config, kObject input, kObject *output, kAlloc alloc)
Invokes an action of the given type without applying the current settings to this node first...

kActions::kActions_TypeDescriptionAt
const kChar * kActions_TypeDescriptionAt(kActions actions, kSize index)
Gets a description of the action type at the specified index.

kActions::kActions_ActionAt
kAction kActions_ActionAt(kActions actions, kSize index)
Gets the action at the specified index.

kXml

kActions::kActions_DeleteAction
kStatus kActions_DeleteAction(kActions actions, kAction action)
Destroys the specified action and removes it from the actions collection.

kActions::kActions_ActionCount
kSize kActions_ActionCount(kActions actions)
Gets the total number of actions belonging to the actions collection.

kActions
Represents configuration for a collection of actions.

kObject

kStatus

kActions::kActions_FindAction
kStatus kActions_FindAction(kActions actions, const kChar *name, kAction *action)
Finds an existing action by name.

kActions::kActions_Clear
kStatus kActions_Clear(kActions actions)
Resets actions collection settings to defaults.