FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kBlock.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_BLOCK_H
9 #define K_FIRESYNC_BLOCK_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kBlock; --forward-declared in kFsDef.x.h
22 
23 
37 kFsFx(kStatus) kBlock_SetId(kBlock block, k32u id);
38 
50 kFsFx(k32u) kBlock_Id(kBlock block);
51 
60 kFsFx(kStatus) kBlock_IdInfo(kBlock block, kInfo32u* info);
61 
70 kFsFx(kStatus) kBlock_SetName(kBlock block, const kChar* name);
71 
79 kFsFx(const kChar*) kBlock_Name(kBlock block);
80 
88 kFsFx(const kChar*) kBlock_TypeName(kBlock block);
89 
103 kFsFx(kStatus) kBlock_AssignGroup(kBlock block, k32u groupId);
104 
112 kFsFx(kBool) kBlock_IsGrouped(kBlock block);
113 
121 kFsFx(k32u) kBlock_GroupId(kBlock block);
122 
136 kFsFx(kStatus) kBlock_SetConfig(kBlock block, kXml settings);
137 
146 kFsFx(kStatus) kBlock_Config(kBlock block, kXml settings);
147 
155 kFsFx(kSize) kBlock_PortCount(kBlock block);
156 
165 kFsFx(kPort) kBlock_PortAt(kBlock block, kSize index);
166 
176 kFsFx(kStatus) kBlock_FindPortById(kBlock block, k32u id, kPort* port);
177 
178 kEndHeader()
179 
180 #include <kFireSync/Client/kBlock.x.h>
181 
182 #endif
kBlock::kBlock_GroupId
k32u kBlock_GroupId(kBlock block)
Gets the processing group id associated with this block.
kBlock::kBlock_FindPortById
kStatus kBlock_FindPortById(kBlock block, k32u id, kPort *port)
Gets the port at the specified index.
kBlock::kBlock_PortCount
kSize kBlock_PortCount(kBlock block)
Gets the number of ports belonging to the block.
kBlock::kBlock_IsGrouped
kBool kBlock_IsGrouped(kBlock block)
Reports whether this block has been assigned to a group.
kBlock::kBlock_Config
kStatus kBlock_Config(kBlock block, kXml settings)
Gets configuration for the block.
kNodeDef.h
Essential declarations related to FireSync nodes.
kBlock::kBlock_SetConfig
kStatus kBlock_SetConfig(kBlock block, kXml settings)
Sets configuration for the block.
kBlock::kBlock_TypeName
const kChar * kBlock_TypeName(kBlock block)
Gets the type name of this block.
kBlock::kBlock_AssignGroup
kStatus kBlock_AssignGroup(kBlock block, k32u groupId)
Assigns this block to a processing group.
kPort
Represents port configuration.
kBlock::kBlock_SetId
kStatus kBlock_SetId(kBlock block, k32u id)
Sets the unique identifier for this block.
kBlock
Represents block configuration.
kBlock::kBlock_Id
k32u kBlock_Id(kBlock block)
Gets the unique identifier for this block.
kBlock::kBlock_Name
const kChar * kBlock_Name(kBlock block)
Gets a descriptive name for this block.
kBlock::kBlock_IdInfo
kStatus kBlock_IdInfo(kBlock block, kInfo32u *info)
Reports constraint and validity information for the Id setting.
kInfo32u
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:79
kBlock::kBlock_SetName
kStatus kBlock_SetName(kBlock block, const kChar *name)
Sets a descriptive name for the block.
kBlock::kBlock_PortAt
kPort kBlock_PortAt(kBlock block, kSize index)
Gets the port at the specified index.