This call
fetches the properties of the specified Global index. The inputs to this call
are CabinetName, UserDBId and Global Index. Only a valid user can fetch the
properties of a Global index. It returns the status of the call along with the
properties of the Global index.
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
Option |
Root |
Unique option for the call |
NGOGetGlobal IndexProperty |
N/A |
CabinetName |
Root |
Name of the cabinet to which the User wants to connect. |
|
N/A |
UserDBId |
Root |
UserDatabase ID, which is returned in the
NGOConnectCabinet call. |
|
N/A |
IndexId |
Root |
Global Index whose properties are to be fetched. |
Integer > 0 |
|
Name |
Parent Tag |
Description |
Option |
Root |
NGOGetGlobalIndexProperty |
Status |
Root |
Status of the call. If the Status is 0, then the call is
successful. |
Field |
Root |
This tag contains the properties of the global index. |
IndexId |
Field |
Index of the Global Index. |
IndexName |
Field |
Name of the Global Index. |
IndexType |
Field |
Type of the Global Index e.g. String, Integer, Float,
Date, Boolean etc. |
IndexLength |
Field |
Length of the Global Index. |
IndexFlag |
Field |
Flag of the Global Index. |
Code |
Message |
Comments |
-50146 |
Invalid session. |
The specified UserDBId is incorrect. |
-50006 |
User account has expired. |
The user’s account has expired. |
-50010 |
User not alive. |
The user is not alive. |
-50125 |
Cabinet has been locked for Administrative purposes. |
The cabinet has been locked by some other user for
Administrative purposes. |
-50043 |
GlobalIndex not found. |
The specified Global Index does not exist. |