kenmirrors
/
freeswitch
mirror of https://github.com/signalwire/freeswitch.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update doxygen for switch_channel_variable_first and switch_channel_variable_last 

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@13227 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
Mathieu Rene 2009-05-04 19:56:46 +00:00
parent a4a82b2a15
commit 578aa78e2b
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/include/switch_channel.h
View File

@ -247,13 +247,16 @@ SWITCH_DECLARE(const char *) switch_channel_get_variable(switch_channel_t *chann
SWITCH_DECLARE(switch_status_t) switch_channel_get_variables(switch_channel_t *channel, switch_event_t **event);
/*!
* Start iterating over the entries in the channel variable list.
* @param channel the channel to intterate the variales for
* @remark Use switch_hash_next and switch_hash_this with this function to iterate all the channel variables
* \brief Start iterating over the entries in the channel variable list.
* \param channel the channel to iterate the variables for
* \remark This function locks the profile mutex, use switch_channel_variable_last to unlock
*/
SWITCH_DECLARE(switch_event_header_t *) switch_channel_variable_first(switch_channel_t *channel);
/*!
* \brief Stop iterating over channel variables.
* \remark Unlocks the profile mutex initially locked in switch_channel_variable_first
*/
SWITCH_DECLARE(void) switch_channel_variable_last(switch_channel_t *channel);
/*!