ASX Version4.13.09
Functions

Block functions.

These functions provide an abstract mechanism to manipulate a well defined set of property primitives that can be combined into a block. More...

Functions

ASX32_API ASX_ERROR ASX_Block_GetInfo (ASX_HANDLE hBlock, char *szBlockName, const unsigned int uStringLength, unsigned int *uParameterCount)
 Gets the name of the block and the number of parameters it has.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetName (ASX_HANDLE hBlock, const unsigned int uParameterIndex, char *szParameterName, const unsigned int uStringLength)
 Gets the name of parameter number uParameterIndex.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetUnits (ASX_HANDLE hBlock, const unsigned int uParameterIndex, char *szParameterUnits, const unsigned int uStringLength)
 Gets the units of parameter number uParameterIndex.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetType (ASX_HANDLE hBlock, const unsigned int uParameterIndex, enum asxUCONTROL_PTYPE *eType)
 Gets the type of parameter number uParameterIndex.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetFlags (ASX_HANDLE hBlock, const unsigned int uParameterIndex, enum asxUCONTROL_PFLAGS *eFlags)
 Gets the flags for parameter number uParameterIndex.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetElementCount (ASX_HANDLE hBlock, const unsigned int uParameterIndex, unsigned int *uCount)
 Gets the number of elements.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetRange (ASX_HANDLE hBlock, const unsigned int uParameterIndex, struct asxParameterRangeInfo *info)
 Gets the parameter range.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetEnumName (ASX_HANDLE hBlock, const unsigned int uParameterIndex, const unsigned int uEnumItem, char *szEnumName, const unsigned int uStringLength)
 Gets the enumerated names for a parameter.
ASX32_API ASX_ERROR ASX_Block_Parameter_Set (ASX_HANDLE hBlock, const unsigned int uParameterIndex, struct asxParameterValue *data)
 Sets a parameter's value field.
ASX32_API ASX_ERROR ASX_Block_Parameter_Get (ASX_HANDLE hBlock, const unsigned int uParameterIndex, struct asxParameterValue *data)
 Gets a parameter's value field.

Detailed Description

These functions provide an abstract mechanism to manipulate a well defined set of property primitives that can be combined into a block.


Function Documentation

ASX32_API ASX_ERROR ASX_Block_GetInfo ( ASX_HANDLE  hBlock,
char *  szBlockName,
const unsigned int  uStringLength,
unsigned int *  uParameterCount 
)

Gets the name of the block and the number of parameters it has.

Parameters:
hBlockA handle to an ASX block.
szBlockNameString used to return the name of the block. It should be of length ASX_SHORT_STRING.
uStringLengthThe length on the string pointed to be szName.
uParameterCountThe number of parameters it has.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_Get ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
struct asxParameterValue data 
)

Gets a parameter's value field.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
dataThe data to get from the parameter. See asxParameterValue.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetElementCount ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
unsigned int *  uCount 
)

Gets the number of elements.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
uCountReturned element count.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetEnumName ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
const unsigned int  uEnumItem,
char *  szEnumName,
const unsigned int  uStringLength 
)

Gets the enumerated names for a parameter.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
uEnumItemThe enumerator index.
szEnumNameString used to return the enumerator name. It should be of length ASX_SHORT_STRING.
uStringLengthThe length on the string pointed to be szName.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetFlags ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
enum asxUCONTROL_PFLAGS eFlags 
)

Gets the flags for parameter number uParameterIndex.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
eFlagsReturned parameter flags. See asxUCONTROL_PFLAGS.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetName ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
char *  szParameterName,
const unsigned int  uStringLength 
)

Gets the name of parameter number uParameterIndex.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
szParameterNameString used to return the name of the parameter. It should be of length ASX_SHORT_STRING.
uStringLengthThe length on the string pointed to be szName.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetRange ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
struct asxParameterRangeInfo info 
)

Gets the parameter range.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
infoReturned range structure. See asxParameterRangeInfo.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetType ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
enum asxUCONTROL_PTYPE eType 
)

Gets the type of parameter number uParameterIndex.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
eTypeReturned parameter type. See asxUCONTROL_PTYPE.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_GetUnits ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
char *  szParameterUnits,
const unsigned int  uStringLength 
)

Gets the units of parameter number uParameterIndex.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
szParameterUnitsString used to return the parameter units. It should be of length ASX_SHORT_STRING.
uStringLengthThe length on the string pointed to be szName.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_Block_Parameter_Set ( ASX_HANDLE  hBlock,
const unsigned int  uParameterIndex,
struct asxParameterValue data 
)

Sets a parameter's value field.

Parameters:
hBlockA handle to an ASX block.
uParameterIndexThe index of the parameter of interest.
dataThe data to set on the parameter. See asxParameterValue.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.