Subversion Repositories HelenOS

Compare Revisions

Ignore whitespace Rev 4755 → Rev 4756

/branches/network/uspace/srv/net/structures/measured_strings.h
65,8 → 65,8
/** Creates a new measured string bundled with a copy of the given string itself as one memory block.
* If the measured string is being freed, whole memory block is freed.
* The measured string should be used only as a constant.
* @param string The initial character string to be stored. Input parameter.
* @param length The length of the given string without the terminating zero ('/0') character. If the length is zero (0), the actual length is computed. The given length is used and appended with the terminating zero ('\\0') character otherwise. Input parameter.
* @param[in] string The initial character string to be stored.
* @param[in] length The length of the given string without the terminating zero ('/0') character. If the length is zero (0), the actual length is computed. The given length is used and appended with the terminating zero ('\\0') character otherwise.
* @returns The new bundled character string with measured length.
* @returns NULL if there is not enough memory left.
*/
73,7 → 73,7
measured_string_ref measured_string_create_bulk( const char * string, size_t length );
 
/** Copies the given measured string with separated header and data parts.
* @param source The source measured string to be copied. Input parameter.
* @param[in] source The source measured string to be copied.
* @returns The copy of the given measured string.
* @returns NULL if the source parameter is NULL.
* @returns NULL if there is not enough memory left.
83,9 → 83,9
/** Receives a measured strings array from a calling module.
* Creates the array and the data memory blocks.
* This method should be used only while processing IPC messages as the array size has to be negotiated in advance.
* @param strings The received measured strings array. Output parameter.
* @param data The measured strings data. This memory block stores the actual character strings. Output parameter.
* @param count The size of the measured strings array. Input parameter.
* @param[out] strings The received measured strings array.
* @param[out] data The measured strings data. This memory block stores the actual character strings.
* @param[in] count The size of the measured strings array.
* @returns EOK on success.
* @returns EINVAL if the strings or data parameter is NULL.
* @returns EINVAL if the count parameter is zero (0).
98,8 → 98,8
 
/** Replies the given measured strings array to a calling module.
* This method should be used only while processing IPC messages as the array size has to be negotiated in advance.
* @param strings The measured strings array to be transferred. Input parameter.
* @param count The measured strings array size. Input parameter.
* @param[in] strings The measured strings array to be transferred.
* @param[in] count The measured strings array size.
* @returns EOK on success.
* @returns EINVAL if the strings parameter is NULL.
* @returns EINVAL if the count parameter is zero (0).
112,10 → 112,10
/** Receives a measured strings array from another module.
* Creates the array and the data memory blocks.
* This method should be used only following other IPC messages as the array size has to be negotiated in advance.
* @param phone The other module phone. Input parameter.
* @param strings The returned measured strings array. Output parameter.
* @param data The measured strings data. This memory block stores the actual character strings. Output parameter.
* @param count The size of the measured strings array. Input parameter.
* @param[in] phone The other module phone.
* @param[out] strings The returned measured strings array.
* @param[out] data The measured strings data. This memory block stores the actual character strings.
* @param[in] count The size of the measured strings array.
* @returns EOK on success.
* @returns EINVAL if the strings or data parameter is NULL.
* @returns EINVAL if the phone or count parameter is not positive (<=0).
127,9 → 127,9
 
/** Sends the given measured strings array to another module.
* This method should be used only following other IPC messages as the array size has to be negotiated in advance.
* @param phone The other module phone. Input parameter.
* @param strings The measured strings array to be transferred. Input parameter.
* @param count The measured strings array size. Input parameter.
* @param[in] phone The other module phone.
* @param[in] strings The measured strings array to be transferred.
* @param[in] count The measured strings array size.
* @returns EOK on success.
* @returns EINVAL if the strings parameter is NULL.
* @returns EINVAL if the phone or count parameter is not positive (<=0).