4.8.10 stat: Get attributes of this object

 

SYNOPSIS

#include <oskit/com/stream.h>

OSKIT_COMDECL oskit_stream_stat(oskit_stream_t *f, [out] oskit_stream_stat_t *out_stat, oskit_u32_t stat_flags);

DESCRIPTION

This method returns the attributes of this stream object. out_stat is a pointer to an oskit_stream_stat_t structure, defined as follows:

struct oskit_stream_stat  {

		oskit_char_t	*name;	/* string name (optional) */
		oskit_u32_t	type;	/* type of object */
		oskit_u64_t	size;	/* size in bytes */
	 

};

PARAMETERS

f

The object whose attributes are desired.

out_stat

The attributes of the stream object.

stat_flags

Which attributes to obtain.

RETURNS

Returns 0 on success, or an error code specified in <oskit/error.h>, on error.