stream.h

Clase wxStreamBase

Esta clase es la clase base de la mayoría de las clases relacionadas con flujos en wxWidgets.

Jerarquía:

Jerarquía de wxStreamBase

Funciones miembro

wxStreamBase()

wxStreamBase::wxStreamBase()

Crea un objeto de flujo ficticio.

No hace nada.

~wxStreamBase()

virtual wxStreamBase::~wxStreamBase()

Destructor,

GetLastError()

wxStreamError wxStreamBase::GetLastError() const

Esta función devuelve el último error.

GetLength()

virtual wxFileOffset wxStreamBase::GetLength() const

Devuelve la longitud del flujo en bytes.

Si no se puede determinar la longitud (esto siempre ocurre, por ejemplo, con los flujos de socket), devuelve wxInvalidOffset.

Reimplementado en wxCountingOutputStream.

GetSize()

virtual size_t wxStreamBase::GetSize() const

Esta función devuelve el tamaño del flujo.

Por ejemplo, en el caso de un archivo, es el tamaño del archivo.

Advertencia

Hay flujos que, por definición, no tienen tamaño, como los flujos de socket. En esos casos, GetSize() devuelve 0, por lo que siempre se debe comprobar su valor de retorno.

IsOk()

virtual bool wxStreamBase::IsOk() const

Devuelve verdadero si no se ha producido ningún error en el flujo.

Ver también GetLastError().

Reimplementado en wxFileStream, wxFFileStream, wxFFileInputStream, wxFileInputStream, wxFileOutputStream, wxFFileOutputStream y wxFSInputStream.

IsSeekable()

virtual bool wxStreamBase::IsSeekable() const

Devuelve verdadero si el flujo admite la búsqueda de desplazamientos arbitrarios.

OnSysSeek()

virtual wxFileOffset wxStreamBase::OnSysSeek( wxFileOffset pos, wxSeekMode mode )

Función interna.

Se invoca cuando el flujo necesita cambiar la posición actual.

Parámetros
pos
Desplazamiento al que se desea buscar.
mode
Uno de los valores de la enumeración wxSeekMode.
Valor de retorno

La nueva posición del flujo o wxFileOffset en caso de error.

OnSysTell()

virtual wxFileOffset wxStreamBase::OnSysTell() const

Función interna.

Se invoca cuando el flujo necesita conocer la posición real.

Valor de retorno

La posición actual del flujo.

Reset()

void wxStreamBase::Reset(wxStreamError error = wxSTREAM_NO_ERROR)

Restablece el estado del flujo.

De forma predeterminada, restablece el flujo a un estado correcto, es decir, borra cualquier error. Desde wxWidgets 2.9.3 también se puede utilizar para establecer explícitamente el estado en el error especificado (el argumento error no existía en las versiones anteriores).

Operadores

operator!()

bool wxStreamBase::operator!() const

Devuelve lo contrario de IsOk().

Se puede utilizar esta función para comprobar la validez del flujo como si fuera un puntero: