CMFCFilterChunkValueImpl クラス

これは、チャンクとプロパティ値のペアの両方のロジックを簡略化するクラスです。

構文

class CMFCFilterChunkValueImpl : public ATL::IFilterChunkValue;

メンバー

パブリック コンストラクター

名前	説明
CMFCFilterChunkValueImpl::~CMFCFilterChunkValueImpl	オブジェクトを破棄します。
CMFCFilterChunkValueImpl::CMFCFilterChunkValueImpl	オブジェクトを構築します。

パブリック メソッド

名前	説明
CMFCFilterChunkValueImpl::Clear	ChunkValue をクリアします。
CMFCFilterChunkValueImpl::CopyChunk	このチャンクを、チャンクの特性を記述する構造にコピーします。
CMFCFilterChunkValueImpl::CopyFrom	このチャンク値を他の値から初期化します。
CMFCFilterChunkValueImpl::GetChunkGUID	チャンク GUID を取得します。
CMFCFilterChunkValueImpl::GetChunkPID	チャンク PID (プロパティ ID) を取得します。
CMFCFilterChunkValueImpl::GetChunkType	チャンクの種類を取得します。
CMFCFilterChunkValueImpl::GetString	文字列値を取得します。
CMFCFilterChunkValueImpl::GetValue	割り当てられたプロバリアントとして値を取得します。
CMFCFilterChunkValueImpl::GetValueNoAlloc	割り当てされていない (内部値) 値を返します。
CMFCFilterChunkValueImpl::IsValid	このプロパティ値が有効かどうかを確認します。
CMFCFilterChunkValueImpl::SetBoolValue	過負荷です。 キーによるプロパティをブール値に設定します。
CMFCFilterChunkValueImpl::SetDwordValue	キーによるプロパティを DWORD に設定します。
CMFCFilterChunkValueImpl::SetFileTimeValue	キーによるプロパティを filetime に設定します。
CMFCFilterChunkValueImpl::SetInt64Value	キーによるプロパティを int64 に設定します。
CMFCFilterChunkValueImpl::SetIntValue	キーによるプロパティを int に設定します。
CMFCFilterChunkValueImpl::SetLongValue	キーによるプロパティを LONG に設定します。
CMFCFilterChunkValueImpl::SetSystemTimeValue	キーによるプロパティを SystemTime に設定します。
CMFCFilterChunkValueImpl::SetTextValue	キーによるプロパティを Unicode 文字列に設定します。

保護メソッド

名前	説明
CMFCFilterChunkValueImpl::SetChunk	チャンクの共通プロパティを設定するヘルパー関数。

解説

使用するには、適切な種類の CMFCFilterChunkValueImpl クラスを作成するだけです

例:

CMFCFilterChunkValueImpl チャンク;

hr = チャンク。SetBoolValue(PKEY_IsAttachment, true);

または

hr = チャンク。SetFileTimeValue(PKEY_ItemDate, ftLastModified);

継承階層

ATL::IFilterChunkValue

CMFCFilterChunkValueImpl

要件

ヘッダー: afxwin.h

CMFCFilterChunkValueImpl::Clear

ChunkValue をクリアします。

void Clear();

解説

CMFCFilterChunkValueImpl::CMFCFilterChunkValueImpl

オブジェクトを構築します。

CMFCFilterChunkValueImpl();

解説

CMFCFilterChunkValueImpl::~CMFCFilterChunkValueImpl

オブジェクトを破棄します。

virtual ~CMFCFilterChunkValueImpl();

解説

CMFCFilterChunkValueImpl::CopyChunk

このチャンクを、チャンクの特性を記述する構造にコピーします。

HRESULT CopyChunk(STAT_CHUNK* pStatChunk);

パラメーター

pStatChunk
チャンクの特性を記述する宛先値へのポインター。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::CopyFrom

このチャンク値を他の値から初期化します。

void CopyFrom (IFilterChunkValue* pValue);

パラメーター

pValue
コピー元のソース値を指定します。

解説

CMFCFilterChunkValueImpl::GetChunkGUID

チャンク GUID を取得します。

REFGUID GetChunkGUID() const;

戻り値

チャンクを識別する GUID への参照。

解説

CMFCFilterChunkValueImpl::GetChunkPID

チャンク PID (プロパティ ID) を取得します。

DWORD GetChunkPID() const;

戻り値

プロパティ ID を含む DWORD 値。

解説

CMFCFilterChunkValueImpl::GetChunkType

チャンクの種類を取得します。

CHUNKSTATE GetChunkType() const;

戻り値

CHUNKSTATE 列挙値。現在のチャンクがテキスト型プロパティか値型プロパティかを指定します。

解説

CMFCFilterChunkValueImpl::GetString

文字列値を取得します。

CString &GetString();

戻り値

チャンク値を含む文字列。

解説

CMFCFilterChunkValueImpl::GetValue

割り当てられたプロバリアントとして値を取得します。

HRESULT GetValue(PROPVARIANT** ppPropVariant);

パラメーター

ppPropVariant
関数が戻るときに、このパラメーターにはチャンク値が含まれます。

戻り値

PROPVARIANT が正常に割り当てられ、チャンク値が正常に ppPropVariant にコピーされた場合はS_OK。それ以外の場合はエラー コードです。

解説

CMFCFilterChunkValueImpl::GetValueNoAlloc

割り当てされていない (内部値) 値を返します。

PROPVARIANT GetValueNoAlloc ();

戻り値

現在のチャンク値を返します。

解説

CMFCFilterChunkValueImpl::IsValid

このプロパティ値が有効かどうかを確認します。

BOOL IsValid() const;

戻り値

現在のチャンク値が有効な場合は TRUE。それ以外の場合は FALSE。

解説

CMFCFilterChunkValueImpl::SetBoolValue

過負荷です。 キーによるプロパティをブール値に設定します。

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);

パラメーター

pkey
プロパティ キーを指定します。

bVal
設定するチャンク値を指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::SetChunk

チャンクの共通プロパティを設定するヘルパー関数。

HRESULT SetChunk(
    REFPROPERTYKEY pkey,
    CHUNKSTATE chunkType=CHUNK_VALUE,
    LCID locale=0,
    DWORD cwcLenSource=0,
    DWORD cwcStartSource=0,
    CHUNK_BREAKTYPE chunkBreakType=CHUNK_NO_BREAK);

パラメーター

pkey
プロパティ キーを指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::SetDwordValue

キーでプロパティを 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);

パラメーター

pkey
プロパティ キーを指定します。

dwVal
設定するチャンク値を指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::SetFileTimeValue

キーでプロパティを 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);

パラメーター

pkey
プロパティ キーを指定します。

dtVal
設定するチャンク値を指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::SetInt64Value

キーでプロパティを 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);

パラメーター

pkey
プロパティ キーを指定します。

nVal
設定するチャンク値を指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::SetIntValue

キーでプロパティを 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);

パラメーター

pkey
プロパティ キーを指定します。

nVal
設定するチャンク値を指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::SetLongValue

キーでプロパティを 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);

パラメーター

pkey
プロパティ キーを指定します。

lVal
設定するチャンク値を指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::SetSystemTimeValue

キーによるプロパティを 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);

パラメーター

pkey
プロパティ キーを指定します。

systemTime
設定するチャンク値を指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

CMFCFilterChunkValueImpl::SetTextValue

キーによるプロパティを 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);

パラメーター

pkey
プロパティ キーを指定します。

pszValue
設定するチャンク値を指定します。

chunkType
フラグは、このチャンクにテキスト型または値型のプロパティが含まれているかどうかを示します。 フラグ値は CHUNKSTATE 列挙型から取得されます。

locale
テキストのチャンクに関連付けられている言語とサブ言語。 チャンク ロケールは、テキストの適切な単語区切りを実行するためにドキュメント インデクサーによって使用されます。 チャンクがテキスト型でも、データ型がVT_LPWSTR、VT_LPSTR、またはVT_BSTRの値型でもない場合、このフィールドは無視されます。

cwcLenSource
現在のチャンクの派生元のソース テキストの文字数。 0 の値は、ソース テキストと派生テキストの間の文字ごとの対応関係を示します。 0 以外の値は、このような直接の対応が存在しないことを意味します。

cwcStartSource
派生チャンクのソース テキストがソース チャンク内で開始されるオフセット。

chunkBreakType
前のチャンクを現在のチャンクから分離する中断の種類。 値は、CHUNK_BREAKTYPE列挙体から取得されます。

戻り値

成功した場合はS_OK。それ以外の場合はエラー コード。

解説

関連項目

クラス