AudioObjectRemovePropertyListener[Block]: documented parameters do not match function
| Originator: | nriley | ||
| Number: | rdar://14101798 | Date Originated: | 09-Jun-2013 01:06 AM |
| Status: | Closed | Resolved: | 09-Jul-2013 01:15 PM |
| Product: | Documentation | Product Version: | Xcode 4.6.2 (4H1003) |
| Classification: | Other Bug | Reproducible: | Always |
In AudioHardware.h, the documentation @params do not match the function arguments for either of these functions:
/*!
@function AudioObjectRemovePropertyListener
@abstract Unregisters the given AudioObjectPropertyListenerProc from receiving
notifications when the given properties change.
@param inObjectID
The AudioObject to unregister the listener from.
@param inNumberAddresses
The number of elements in the inAddresses array.
@param inAddresses
The AudioObjectPropertyAddress indicating which property the listener should
be removed from.
@param inListener
The AudioObjectPropertyListenerProc being removed.
@param inClientData
A pointer to client data that is passed to the listener when it is called.
@result An OSStatus indicating success or failure.
*/
extern OSStatus
AudioObjectRemovePropertyListener( AudioObjectID inObjectID,
const AudioObjectPropertyAddress* inAddress,
AudioObjectPropertyListenerProc inListener,
void* inClientData) __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_2_0);
/*!
@function AudioObjectRemovePropertyListenerBlock
@abstract Unregisters the given AudioObjectPropertyListenerBlock from receiving
notifications when the given properties change.
@param inObjectID
The AudioObject to unregister the listener from.
@param inNumberAddresses
The number of elements in the inAddresses array.
@param inAddresses
The AudioObjectPropertyAddress indicating which property the listener should
be removed from.
@param inDispatchQueue
The dispatch queue on which the listener block was being dispatched to.
@param inListener
The AudioObjectPropertyListenerBlock being removed.
@result An OSStatus indicating success or failure.
*/
extern OSStatus
AudioObjectRemovePropertyListenerBlock( AudioObjectID inObjectID,
const AudioObjectPropertyAddress* inAddress,
dispatch_queue_t inDispatchQueue,
AudioObjectPropertyListenerBlock inListener) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
Comments
Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!