ASX Version4.13.09
Functions

Node functions

The node functions are used to access nodes objects. More...

Functions

ASX32_API ASX_ERROR ASX_Node_GetType (ASX_HANDLE hNode, enum asxNODE *peType)
 Returns the node type of the given node.
ASX32_API ASX_ERROR ASX_Node_GetIndex (ASX_HANDLE hNode, int *pnIndex)
 Returns the index of the given node.
ASX32_API ASX_ERROR ASX_Node_GetLocation (ASX_HANDLE hNode, int *pnModuleSlot, int *pnNodeIndexOnSlot, char *pszModuleName, const int nStringLength)
 Returns the location of the given node in terms of module slots and position on the module that contains the node.
ASX32_API ASX_ERROR ASX_Node_GetSubSystem (ASX_HANDLE hNode, int *p_nSubSystem)
 Returns the sub system handle of the given node.
ASX32_API ASX_ERROR ASX_Node_GetName (ASX_HANDLE hNode, char *pszNodeName, const int nStringLength)
 Get the name of the node.
ASX32_API ASX_ERROR ASX_Mixer_GetNodeType (ASX_HANDLE hNode, enum asxNODE *peType)
ASX32_API ASX_ERROR ASX_Mixer_GetNodeIndex (ASX_HANDLE hNode, int *pnIndex)

Detailed Description

The node functions are used to access nodes objects.

The node objects as they are implemented in ASX are really just placeholders. These functions allow an application to query node information, including the node type, index and name. Often these functions will be called after after the source and/or destination nodes of a particular control have been obtained.


Function Documentation

ASX32_API ASX_ERROR ASX_Mixer_GetNodeIndex ( ASX_HANDLE  hNode,
int *  pnIndex 
)
Deprecated:
This function has been superseded by ASX_Node_GetIndex()
ASX32_API ASX_ERROR ASX_Mixer_GetNodeType ( ASX_HANDLE  hNode,
enum asxNODE peType 
)
Deprecated:
This function has been superseded by ASX_Node_GetType()
ASX32_API ASX_ERROR ASX_Node_GetIndex ( ASX_HANDLE  hNode,
int *  pnIndex 
)

Returns the index of the given node.

Parameters:
hNodeA handle to an ASX node object.
pnIndexThe returned ASX node index. For example, if the hNode object represented the second line out, pnIndex would return 1. Index 0 would be the first line out, so index 1 is the second line out. Also returns 0 if hNode=asxNODE_NONE.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
cobranet/main.c, and mixer/main.c.
ASX32_API ASX_ERROR ASX_Node_GetLocation ( ASX_HANDLE  hNode,
int *  pnModuleSlot,
int *  pnNodeIndexOnSlot,
char *  pszModuleName,
const int  nStringLength 
)

Returns the location of the given node in terms of module slots and position on the module that contains the node.

Parameters:
hNodeA handle to an ASX node object.
pnModuleSlotThe returned module's slot number.
pnNodeIndexOnSlotThe returned node's index on the module.
pszModuleNameThe returned module name. This wil be something like "ASI1441". The string passed in should be of length ASX_SHORT_STRING.
nStringLengthThe length of the passed in string.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Node_GetName ( ASX_HANDLE  hNode,
char *  pszNodeName,
const int  nStringLength 
)

Get the name of the node.

Parameters:
hNodeA handle to an ASX node object.
pszNodeNameThe string buffer of size nStringLength allocated by the caller.
nStringLengthThe length of the pszNodeName buffer. Should be ASX_LONG_STRING.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Node_GetSubSystem ( ASX_HANDLE  hNode,
int *  p_nSubSystem 
)

Returns the sub system handle of the given node.

Parameters:
hNodeA handle to an ASX node object.
p_nSubSystemThe returned ASX sub system type.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Node_GetType ( ASX_HANDLE  hNode,
enum asxNODE peType 
)

Returns the node type of the given node.

Parameters:
hNodeA handle to an ASX node object.
peTypeThe returned ASX node type. This will below to one of asxNODE. If hNode is null, *peNode=asxNODE_NONE - this is not an error.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
cobranet/main.c, and mixer/main.c.