CMFCFilterChunkValueImpl (clase)
Se trata de una clase que simplifica la lógica del par de valores de propiedad y fragmento.
Sintaxis
class CMFCFilterChunkValueImpl : public ATL::IFilterChunkValue;
Miembros
Constructores públicos
Nombre | Descripción |
---|---|
CMFCFilterChunkValueImpl::~CMFCFilterChunkValueImpl | Destruye el objeto. |
CMFCFilterChunkValueImpl::CMFCFilterChunkValueImpl | Este constructor se usa para construir el objeto . |
Métodos públicos
Nombre | Descripción |
---|---|
CMFCFilterChunkValueImpl::Clear | Borra ChunkValue. |
CMFCFilterChunkValueImpl::CopyChunk | Copia este fragmento en una estructura que describe las características de un fragmento. |
CMFCFilterChunkValueImpl::CopyFrom | Inicializa este valor de fragmento desde el otro valor. |
CMFCFilterChunkValueImpl::GetChunkGUID | Recupera el GUID del fragmento. |
CMFCFilterChunkValueImpl::GetChunkPID | Recupera el PID (identificador de propiedad) del fragmento. |
CMFCFilterChunkValueImpl::GetChunkType | Obtiene el tipo de fragmento. |
CMFCFilterChunkValueImpl::GetString | Recupera el valor de cadena. |
CMFCFilterChunkValueImpl::GetValue | Recupera el valor como una clase propvariant asignada. |
CMFCFilterChunkValueImpl::GetValueNoAlloc | Devuelve un valor (valor interno) no asignado. |
CMFCFilterChunkValueImpl::IsValid | Comprueba si este valor de propiedad es válido o no. |
CMFCFilterChunkValueImpl::SetBoolValue | Con sobrecarga. Establece la propiedad por clave en un valor booleano. |
CMFCFilterChunkValueImpl::SetDwordValue | Establece la propiedad por clave en un valor DWORD. |
CMFCFilterChunkValueImpl::SetFileTimeValue | Establece la propiedad por clave en un valor filetime. |
CMFCFilterChunkValueImpl::SetInt64Value | Establece la propiedad por clave en un valor int64. |
CMFCFilterChunkValueImpl::SetIntValue | Establece la propiedad por clave en un valor int. |
CMFCFilterChunkValueImpl::SetLongValue | Establece la propiedad por clave en un valor LONG. |
CMFCFilterChunkValueImpl::SetSystemTimeValue | Establece la propiedad por clave en SystemTime. |
CMFCFilterChunkValueImpl::SetTextValue | Establece la propiedad por clave en una cadena Unicode. |
Métodos protegidos
Nombre | Descripción |
---|---|
CMFCFilterChunkValueImpl::SetChunk | Función auxiliar que establece las propiedades comunes del fragmento. |
Comentarios
Para usarla, basta con crear una clase CMFCFilterChunkValueImpl del tipo correcto.
Ejemplo:
Fragmento CMFCFilterChunkValueImpl;
hr = chunk.SetBoolValue(PKEY_IsAttachment, true);
o
hr = chunk.SetFileTimeValue(PKEY_ItemDate, ftLastModified);
Jerarquía de herencia
ATL::IFilterChunkValue
Requisitos
Encabezado: afxwin.h
CMFCFilterChunkValueImpl::Clear
Borra ChunkValue.
void Clear();
Comentarios
CMFCFilterChunkValueImpl::CMFCFilterChunkValueImpl
Este constructor se usa para construir el objeto .
CMFCFilterChunkValueImpl();
Comentarios
CMFCFilterChunkValueImpl::~CMFCFilterChunkValueImpl
Destruye el objeto.
virtual ~CMFCFilterChunkValueImpl();
Comentarios
CMFCFilterChunkValueImpl::CopyChunk
Copia este fragmento en una estructura que describe las características de un fragmento.
HRESULT CopyChunk(STAT_CHUNK* pStatChunk);
Parámetros
pStatChunk
Puntero al valor de destino que describe las características del fragmento.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::CopyFrom
Inicializa este valor de fragmento desde el otro valor.
void CopyFrom (IFilterChunkValue* pValue);
Parámetros
pValue
Especifica los datos de origen desde los que copiar.
Comentarios
CMFCFilterChunkValueImpl::GetChunkGUID
Recupera el GUID del fragmento.
REFGUID GetChunkGUID() const;
Valor devuelto
Referencia a un GUID que identifica el fragmento.
Comentarios
CMFCFilterChunkValueImpl::GetChunkPID
Recupera el PID (identificador de propiedad) del fragmento.
DWORD GetChunkPID() const;
Valor devuelto
Valor DWORD que contiene el identificador de propiedad.
Comentarios
CMFCFilterChunkValueImpl::GetChunkType
Recupera el tipo de fragmento.
CHUNKSTATE GetChunkType() const;
Valor devuelto
Valor enumerado CHUNKSTATE, que especifica si el fragmento actual es una propiedad de tipo texto o una propiedad de tipo valor.
Comentarios
CMFCFilterChunkValueImpl::GetString
Recupera el valor de cadena.
CString &GetString();
Valor devuelto
Cadena que contiene el valor del fragmento.
Comentarios
CMFCFilterChunkValueImpl::GetValue
Recupera el valor como una clase propvariant asignada.
HRESULT GetValue(PROPVARIANT** ppPropVariant);
Parámetros
ppPropVariant
Cuando la función devuelve resultados, este parámetro contiene el valor del fragmento.
Valor devuelto
S_OK si PROPVARIANT se asignó correctamente y el valor del fragmento se copió correctamente en ppPropVariant; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::GetValueNoAlloc
Devuelve el valor no asignado (valor interno).
PROPVARIANT GetValueNoAlloc ();
Valor devuelto
Devuelve el valor del fragmento actual.
Comentarios
CMFCFilterChunkValueImpl::IsValid
Comprueba si este valor de propiedad es válido o no.
BOOL IsValid() const;
Valor devuelto
TRUE si el valor del fragmento actual es válido; en caso contrario, FALSE.
Comentarios
CMFCFilterChunkValueImpl::SetBoolValue
Con sobrecarga. Establece la propiedad por clave en un valor booleano.
HRESULT SetBoolValue(
REFPROPERTYKEY pkey,
BOOL bVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
HRESULT SetBoolValue(
REFPROPERTYKEY pkey,
VARIANT_BOOL bVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
bVal
Especifica el valor del fragmento que se va a establecer.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::SetChunk
Función auxiliar que establece las propiedades comunes del fragmento.
HRESULT SetChunk(
REFPROPERTYKEY pkey,
CHUNKSTATE chunkType=CHUNK_VALUE,
LCID locale=0,
DWORD cwcLenSource=0,
DWORD cwcStartSource=0,
CHUNK_BREAKTYPE chunkBreakType=CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::SetDwordValue
Establezca la propiedad por clave en un valor DWORD.
HRESULT SetDwordValue(
REFPROPERTYKEY pkey,
DWORD dwVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
dwVal
Especifica el valor del fragmento que se va a establecer.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::SetFileTimeValue
Establece la propiedad por clave en un valor filetime.
HRESULT SetFileTimeValue(
REFPROPERTYKEY pkey,
FILETIME dtVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
dtVal
Especifica el valor del fragmento que se va a establecer.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::SetInt64Value
Establece la propiedad por clave en un valor int64.
HRESULT SetInt64Value(
REFPROPERTYKEY pkey,
__int64 nVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
nVal
Especifica el valor del fragmento que se va a establecer.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::SetIntValue
Establece la propiedad por clave en un valor int.
HRESULT SetIntValue(
REFPROPERTYKEY pkey,
int nVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
nVal
Especifica el valor del fragmento que se va a establecer.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::SetLongValue
Establece la propiedad por clave en un valor LONG.
HRESULT SetLongValue(
REFPROPERTYKEY pkey,
long lVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
lVal
Especifica el valor del fragmento que se va a establecer.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::SetSystemTimeValue
Establece la propiedad por clave en SystemTime.
HRESULT SetSystemTimeValue(
REFPROPERTYKEY pkey,
const SYSTEMTIME& systemTime,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale=0,
DWORD cwcLenSource=0,
DWORD cwcStartSource=0,
CHUNK_BREAKTYPE chunkBreakType=CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
systemTime
Especifica el valor del fragmento que se va a establecer.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.
Comentarios
CMFCFilterChunkValueImpl::SetTextValue
Establece la propiedad por clave en una cadena Unicode.
HRESULT SetTextValue(
REFPROPERTYKEY pkey,
LPCTSTR pszValue,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parámetros
pkey
Especifica una clave de propiedad.
pszValue
Especifica el valor del fragmento que se va a establecer.
chunkType
Las marcas indican si este fragmento contiene una propiedad de tipo texto o tipo valor. Los valores de las marcas se toman de la enumeración CHUNKSTATE.
locale
Lenguaje y sublenguaje asociados a un fragmento de texto. Los indexadores de documentos usan la configuración regional del fragmento para dividir el texto en palabras de la manera adecuada. Si el fragmento no es de tipo texto ni de tipo valor con un tipo de datos VT_LPWSTR, VT_LPSTR o VT_BSTR, se omite este campo.
cwcLenSource
Longitud de caracteres del texto de origen del que se deriva el fragmento actual. Un valor de cero significa correspondencia carácter con carácter entre el texto de origen y el texto derivado. Un valor distinto de cero significa que no existe ninguna correspondencia directa.
cwcStartSource
Desplazamiento desde el que se inicia el texto de origen de un fragmento derivado en el fragmento de origen.
chunkBreakType
Tipo de división que separa el fragmento anterior del fragmento actual. Los valores proceden de la enumeración CHUNK_BREAKTYPE.
Valor devuelto
S_OK si es correcto; de lo contrario, un código de error.