Framework:FKT DimGetChildIndex: Difference between revisions
No edit summary |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
This function returns the position of the child element (Child_CopSysId) below its parent element (Parent_CopSysId). The index is 0 based. This means that the first child element has 0 as an index. In the case of an error (dimension/paarent element/child element not found) “-1” is returned and a warning providing information on what caused the error is written into the ServerLog. | This function returns the position of the child element (Child_CopSysId) below its parent element (Parent_CopSysId). The index is 0 based. This means that the first child element has 0 as an index. In the case of an error (dimension/paarent element/child element not found) “-1” is returned and a warning providing information on what caused the error is written into the ServerLog. | ||
FKT_DimGetChildIndex (<dimension name>, <Parent_CopSysId>, <Child_CopSysId>) | <span {{CoPFormel}}>FKT_DimGetChildIndex(<dimension name>, <Parent_CopSysId>, <Child_CopSysId>)</span> | ||
{|class="wikitable" width="80%" | |||
{| | |- {{Tabellentitel}} | ||
|- | | Parameter | ||
| | | Description | ||
| | |||
|- | |- | ||
|Dimension name | |Dimension name | ||
| Line 20: | Line 19: | ||
|COPSYS_ID of the child element whose index is looked up | |COPSYS_ID of the child element whose index is looked up | ||
|} | |} | ||
This function belongs to [[:Category:Functions_-_server-side|server-side functions]]. | |||
==Result== | ==Result== | ||
Index (position) of the child element with regard to the parent element | Index (position) of the child element with regard to the parent element | ||
==Example== | ==Example== | ||
The index of the Jan 05 element is to be returned | The index of the Jan 05 element is to be returned | ||
FKT_DimGetChildIndex(dim_sys_time, 2005010101, 2005010103) = result 0 | <span {{CoPFormel}}>FKT_DimGetChildIndex(dim_sys_time, 2005010101, 2005010103)</span> = result 0 | ||
The index of the Jun 05 element is to be returned | The index of the Jun 05 element is to be returned | ||
FKT_DimGetChildIndex(dim_sys_time, 2005010101, 2005010603) = result 5 | <span {{CoPFormel}}>FKT_DimGetChildIndex(dim_sys_time, 2005010101, 2005010603)</span> = result 5 | ||
__NOEDITSECTION__ | __NOEDITSECTION__ | ||
[[Category:Functions|DimGetChildIndex]] | |||
[[Category:Functions_-_server-side|DimGetChildIndex]] | [[Category:Functions_-_server-side|DimGetChildIndex]] | ||
[[de:Framework:FKT DimGetChildIndex]] | [[de:Framework:FKT DimGetChildIndex]] | ||
Latest revision as of 08:33, 24 May 2012
Function
This function returns the position of the child element (Child_CopSysId) below its parent element (Parent_CopSysId). The index is 0 based. This means that the first child element has 0 as an index. In the case of an error (dimension/paarent element/child element not found) “-1” is returned and a warning providing information on what caused the error is written into the ServerLog.
FKT_DimGetChildIndex(<dimension name>, <Parent_CopSysId>, <Child_CopSysId>)
| Parameter | Description |
| Dimension name | Name of the dimension from which the index of an element is looked up. |
| Parent_CopSysId | COPSYS_ID of the parent element |
| Child_CopSysId | COPSYS_ID of the child element whose index is looked up |
This function belongs to server-side functions.
Result
Index (position) of the child element with regard to the parent element
Example
The index of the Jan 05 element is to be returned
FKT_DimGetChildIndex(dim_sys_time, 2005010101, 2005010103) = result 0
The index of the Jun 05 element is to be returned
FKT_DimGetChildIndex(dim_sys_time, 2005010101, 2005010603) = result 5
