Miles Sound System SDK 7.2a

AIL_platform_property

The function AIL_platform_property retrieves and/or sets platform-specific properties for the Miles Sound System.

S32 AIL_platform_property(
  void object,
  MSS_PLATFORM_PROPERTY property,
  void *before_value,
  void const * new_value,
  void *after_value
);

In Parameters

object: where required, indicates the HDIGDRIVER, HSAMPLE, or other MSS object handle whose platform-specific properties are to be accessed.
property: specifies which platform-specific property is to be retrieved or set.
new_value: is a pointer to a new value to set. If you don't want to set the property, pass in 0.

Out Parameters

before_value: is a pointer to a variable that will contain the property value before changing it. Always use this pointer to retrieve read-only properties. You can use 0 if you don't want to retrieve the prior value.
after_value: is a pointer to a variable that will contain the property value after changing it. You can use 0 if you don't want to retrieve the post-value.

Returns

Non-zero for success, 0 for failure.

Discussion

Applications which need to access internal MSS objects such as thread and window handles and DirectSound buffers may use this function to query and (in some cases) modify these object values. See the MSS_PLATFORM_PROPERTY type for a list of properties available under various platforms supported by Miles.

Most applications do not need to use this function. Unpredictable and difficult-to-troubleshoot consequences may arise from careless use of AIL_platform_property!

Group: System Services
Related Functions: AIL_platform_property
Related Basic Types: MSS_PLATFORM_PROPERTY, S32, void, void const *