PFNCOMPROPSHEET コールバック関数 (compstui.h)

[アーティクル]
02/06/2025

ComPropSheet 関数は、CPSUI によって提供され、CPSUI アプリケーション (プリンターインターフェイス DLL を含む) から呼び出してプロパティシートページを作成できます。

構文

PFNCOMPROPSHEET Pfncompropsheet;

LONG_PTR Pfncompropsheet(
  [in] HANDLE hComPropSheet,
  [in] UINT Function,
  [in] LPARAM lParam1,
  [in] LPARAM lParam2
)
{...}

パラメーター

[in] hComPropSheet

グループ親プロパティシートへの呼び出し元指定ハンドル。詳細については、次の「解説」セクションを参照してください。

[in] Function

ComPropSheet 関数によって実行される操作を指定する、呼び出し元が指定した、CPSFUNC_プレフィックスが付いた ComPropSheet 関数コード。以下の「解説」セクションの「ComPropSheet 関数コード」の表を参照してください。

[in] lParam1

ComPropSheet 関数コードに依存する呼び出し元指定の値関数。

[in] lParam2

ComPropSheet 関数コードに依存する呼び出し元指定の値関数。

戻り値

戻り値は、関数に指定 ComPropSheet 関数コードによって異なります。

備考

CPSUI は、アプリケーションの PFNPROPSHEETUI型指定された関数のいずれかを呼び出すと、PROPSHEETUI_INFO 構造体の ComPropSheet 関数へのポインターを渡します。 PFNPROPSHEETUI型指定された関数は、ComPropSheet 関数を呼び出して、プロパティシートページを CPSUI に記述できます。

プリンターインターフェイス DLL は、DrvDocumentPropertySheets 関数またはその DrvDevicePropertySheets 関数内から、ComPropSheet を呼び出すことができます。

Microsoft Unidrv および Pscript ドライバー用のユーザーインターフェイスプラグインは、IPrintOemUI::D ocumentPropertySheets および IPrintOemUI::D evicePropertySheets メソッド内からComPropSheet を呼び出すことができます。

hComPropSheet パラメーターに指定されたグループの親ハンドルは、次のいずれかになります。

PROPSHEETUI_INFO 構造体の hComPropSheet メンバーで受け取ったハンドル。
以前に CPSFUNC_INSERT_PSUIPAGE 関数コードを使用して comPropSheet 呼び出し、INSERTPSUIPAGE_INFO 構造体の Type メンバーとしてPSUIPAGEINSERT_GROUP_PARENTを指定した結果として受け取ったハンドル。

ComPropSheet 関数コード

CPSUI の ComPropSheet 関数には、次の関数コードを渡すことができます。

CPSFUNC_ADD_HPROPSHEETPAGE

CPSFUNC_ADD_HPROPSHEETPAGE 関数コードにより、ComPropSheet 関数は、CreatePropertySheetPage 関数を呼び出して作成されたプロパティシートページを追加します。

パラメーター (CPSFUNC_ADD_HPROPSHEETPAGE)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、プロパティシートページを追加するために comPropSheet 呼び出すときに、この関数コードパラメーターを CPSFUNC_ADD_HPROPSHEETPAGE に設定します
lParam1: CreatePropertySheetPage 関数を呼び出して取得したプロパティシートページへのハンドル
lParam2: 使用せず、ゼロにする必要があります

戻り値 (CPSFUNC_ADD_HPROPSHEETPAGE)

操作が成功した場合、ComPropSheet は追加されたページに CPSUI ハンドルを返します。それ以外の場合は NULL を返します。

CPSFUNC_ADD_PCOMPROPSHEETUI

CPSFUNC_ADD_PCOMPROPSHEETUI 関数コードにより、ComPropSheet 関数は、COMPROPSHEETUI 構造体によって記述される 1 つ以上のプロパティシートページのセットを追加します。

パラメーター

hComPropSheet の: 親ハンドルをグループ化する
関数: 呼び出し元は、ComPropSheet を呼び出して 1 つまたは複数のプロパティシートページのセット を追加するときに、この関数コードパラメーターを CPSFUNC_ADD_PCOMPROPSHEETUI に設定します
lParam1: COMPROPSHEETUI 構造体へのポインター
lParam2: 追加されたページ数を受け取る 32 ビットの場所へのポインター、またはエラーが発生した場合は、ERR_CPSUIプレフィックス付きのエラーコード

戻り値

操作が成功した場合、ComPropSheet は、追加されたページのセットへのハンドルを返します。それ以外の場合、関数は NULL を返します。

CPSFUNC_ADD_PFNPROPSHEETUI

CPSFUNC_ADD_PFNPROPSHEETUI 関数コードにより、ComPropSheet 関数は、指定された PFNPROPSHEETUI 型の関数を呼び出します。この関数は、1 つまたは複数のプロパティシートページのセットを追加する必要があります。

パラメーター (CPSFUNC_ADD_PFNPROPSHEETUI)

hComPropSheet の: 親ハンドルをグループ化する
関数: 呼び出し元は、ComPropSheet を呼び出すときに、この関数コードパラメーターCPSFUNC_ADD_PFNPROPSHEETUI に設定します。 comPropSheet 指定した PFNPROPSHEETUI 型の関数を呼び出して、1 つまたは複数のプロパティシートページのセットを追加します。
lParam1: PFNPROPSHEETUI 型の関数へのポインター
lParam2: その lParam パラメーターに対して PFNPROPSHEETUI 型の関数に渡される 32 ビット値

戻り値 (CPSFUNC_ADD_PFNPROPSHEETUI)

操作が成功した場合、ComPropSheet は、追加されたページのセットへのハンドルを返します。それ以外の場合、関数は NULL を返します。

CPSFUNC_ADD_PROPSHEETPAGE

CPSFUNC_ADD_PROPSHEETPAGE 関数コードにより、ComPropSheet 関数は、PROPSHEETPAGE 構造体によって記述されるプロパティシートページの型を追加します。

パラメーター (CPSFUNC_ADD_PROPSHEETPAGE)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、この関数コードパラメーター ComPropSheet を呼び出して、PROPSHEETPAGE 構造体によって記述されたプロパティシートページの型を追加するときに CPSFUNC_ADD_PROPSHEETPAGE するように設定します。 ComPropSheet 関数は、CreatePropertySheetPage 関数を呼び出し、ページを作成するために、PROPSHEETPAGE 構造体のアドレスを渡します。
lParam1: PROPSHEETPAGE 構造体へのポインター
lParam2: 使用せず、ゼロにする必要があります

戻り値 (CPSFUNC_ADD_PROPSHEETPAGE)

操作が成功した場合、ComPropSheet は追加されたページに CPSUI ハンドルを返します。それ以外の場合は NULL を返します。

CPSFUNC_DELETE_HCOMPROPSHEET

CPSFUNC_DELETE_HCOMPROPSHEET 関数コードにより、ComPropSheet 関数は、CPSUI ハンドルで指定されたプロパティシートページのセットを削除します。

パラメーター (CPSFUNC_DELETE_HCOMPROPSHEET)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、プロパティシートページのセットを削除するために ComPropSheet 呼び出すときに、この関数コードパラメーターを CPSFUNC_DELETE_HCOMPROPSHEET に設定します
lParam1: 削除するページのセットを参照する CPSUI ハンドル。このハンドルは、次のいずれかの関数コードを使用して、ComPropSheet を呼び出すことによって取得されている必要があります。
- CPSFUNC_ADD_HPROPSHEETPAGE
- CPSFUNC_ADD_PCOMPROPSHEETUI
- CPSFUNC_ADD_PFNPROPSHEETUI
- CPSFUNC_ADD_PROPSHEETPAGE
- CPSFUNC_INSERT_PSUIPAGE
lParam2: 使用せず、ゼロにする必要があります

戻り値 (CPSFUNC_DELETE_HCOMPROPSHEET)

ComPropSheet 関数は、削除されたプロパティシートページの数を返します。

CPSFUNC_DO_APPLY_CPSUI

CPSFUNC_DO_APPLY_CPSUI 関数コードにより、ComPropSheet 関数は、PSN_APPLY通知メッセージの配信をシミュレートします。

CPSUI は、アプリケーションの_CPSUICALLBACK型指定コールバック関数に CPSUICB_REASON_APPLYNOW 理由を提供することで、CPSFUNC_DO_APPLY_CPSUI 関数コードに応答します。

パラメーター (CPSFUNC_DO_APPLY_CPSUI)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、PSN_APPLY通知メッセージの配信をシミュレートするために comPropSheet 呼び出すときに、この関数コードパラメーターを CPSFUNC_DO_APPLY_CPSUI に設定します
lParam1: 1 つまたは複数のプロパティシートページのセットを指す CPSUI ハンドル。通常、このハンドルは、CPSFUNC_IGNORE_CPSUI_PSN_APPLY 関数コードを使用して comPropSheet をする lParam1 パラメーターとして以前に指定されています。
lParam2: このパラメーターは、次のビットフラグの任意の組み合わせです。
- APPLYCPSUI_NO_NEWDEF - 現在の既定値 (元に戻す操作に使用) を変更しない場合は、このフラグを設定します。すべてのオプションの現在の値を元に戻す操作に使用される既定値にする場合は、このフラグをオフにします。
- APPLYCPSUI_OK_CANCEL_BUTTON - ユーザーが [OK] または [キャンセル] ボタンを選択した場合 (またはこのアクティビティをシミュレートする場合) に、このフラグを設定します。ユーザーが [閉じる] または [今すぐ適用] ボタンを選択した場合 (またはこのアクティビティをシミュレートする場合) は、このフラグをオフにします。コードが PSN_APPLY メッセージを受信するように設定されている場合は、PSHNOTIFY 構造体の lParam メンバーを確認する必要があります。メンバーが 0 の場合は、このビットをクリアする必要があります。

戻り値 (CPSFUNC_DO_APPLY_CPSUI)

操作が成功した場合、ComPropSheet 関数は 0 以外の値を返します。それ以外の場合は 0 が返され、指定したページがアクティブになります。

CPSFUNC_IGNORE_CPSUI_PSN_APPLY 関数コードを使用して CPSUI によるPSN_APPLY通知メッセージの処理を無効にする場合は、CPSFUNC_DO_APPLY_CPSUI 関数コードを使用して、PSN_APPLY メッセージの配信をシミュレートする必要があります。それ以外の場合は、プロパティシートページに対するユーザーの変更を取得できません。

CPSFUNC_GET_HPSUIPAGES

CPSFUNC_GET_HPSUIPAGES 関数コードにより、ComPropSheet 関数は、プロパティシートページを指す CPSUI ハンドルの配列を返します。これらのハンドルは、指定されたグループ親ハンドルに関連付けられている子ページを識別します。

この関数コードを使用するには、次の手順に従います。

CPSFUNC_GET_PAGECOUNT 関数コードを指定 ComPropSheetを呼び出して、指定したグループの親に関連付けられている子ページの数を取得します。
各ページの HANDLE 構造体を格納するのに十分なローカルメモリを割り当てます。
comPropSheet を呼び出し、CPSFUNC_GET_HPSUIPAGES 関数コードとローカルに割り当てられたメモリのアドレスを指定して、HANDLE 構造体の配列を取得します。

パラメーター (CPSFUNC_GET_HPSUIPAGES)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、この関数コードパラメーターを、CPSUI ハンドルの配列を取得するために comPropSheet 呼び出すときに CPSFUNC_GET_HPSUIPAGES に設定します
lParam1: HANDLE 構造体の配列へのポインター
lParam2: lParam1 が指す HANDLE 配列のサイズ

戻り値 (CPSFUNC_GET_HPSUIPAGES)

ComPropSheet 関数は、CPSUI が HANDLE 配列に配置するハンドルの数を返します。

CPSFUNC_GET_PAGECOUNT

CPSFUNC_GET_PAGECOUNT 関数コードにより、ComPropSheet 関数は、指定されたグループ親ハンドルの子ページであるプロパティシートページの数を返します。

パラメーター (CPSFUNC_GET_PAGECOUNT)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、子ページ数を返すために ComPropSheet 呼び出すときに、この関数コードパラメーターを CPSFUNC_GET_PAGECOUNT に設定します
lParam1: 使用せず、ゼロにする必要があります
lParam2: 使用せず、ゼロにする必要があります

戻り値 (CPSFUNC_GET_PAGECOUNT)

ComPropSheet 関数は、カウントされたページ数を返します。

CPSFUNC_GET_PFNPROPSHEETUI_ICON

CPSFUNC_GET_PFNPROPSHEETUI_ICON 関数コードにより、ComPropSheet 関数は、プロパティシートページのセットに関連付けられているアイコンへのハンドルを返します。ページのセットは、PFNPROPSHEETUI 型の関数によって以前に作成されている必要があります。

ComPropSheet 関数は、指定したページハンドルに関連付けられた PFNPROPSHEETUI 型の関数を呼び出し、理由値として PROPSHEETUI_REASON_GET_ICONを渡します。その後、PFNPROPSHEETUI 型の関数は LoadImage呼び出し、アイコンリソースを読み込むには、bylParam2 で指定されたアイコンサイズを提供します。

パラメーター (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、一連のプロパティシートページに関連付けられているアイコン ハンドルを取得する ComPropSheet を呼び出すときに、この関数コードパラメーターを CPSFUNC_GET_PFNPROPSHEETUI_ICON に設定します
lParam1: プロパティシートページのセットを参照する CPSUI ハンドル。このハンドルは、CPSFUNC_ADD_PFNPROPSHEETUI 関数コードを使用して comPropSheet を呼び出すことによって取得されている必要があります。
lParam2: アイコンのサイズを表す 2 つの WORD サイズの値をピクセル単位で指定します。 LOWORD 値は幅、HIWORD 値は高さです。これらの値が 0 の場合、システムメトリックSM_CXICONとSM_CYICONが使用されます。詳細については、「GetSystemMetricsを参照してください。

戻り値 (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

操作が成功した場合、ComPropSheet 関数はアイコンハンドルを返します。それ以外の場合は NULL を返します。

CPSFUNC_IGNORE_CPSUI_PSN_APPLY

CPSFUNC_IGNORE_CPSUI_PSN_APPLY 関数コードにより、ComPropSheet 関数は、cpsui の PSN_APPLY 通知メッセージの処理を無効または再び有効にします。

システムは、ユーザーがプロパティシートの [OK] または [キャンセル] ボタンを選択すると、PSN_APPLY通知メッセージを CPSUI に送信します。 CPSUI は、アプリケーションの_CPSUICALLBACK型指定コールバック関数に CPSUICB_REASON_APPLYNOW 理由を提供することで、このメッセージに応答します。

CPSUI によるPSN_APPLY通知メッセージの処理を無効にする場合は、CPSFUNC_DO_APPLY_CPSUI 関数コードを使用して、PSN_APPLY メッセージの配信をシミュレートする必要があります。それ以外の場合は、プロパティシートページに対するユーザーの変更を取得できません。

CPSFUNC_IGNORE_CPSUI_PSN_APPLY 関数コードが使用されていない場合、CPSUI によるPSN_APPLY通知メッセージの処理が既定で有効になります。

パラメーター (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、PSN_APPLY通知メッセージの CPSUI の処理 無効または再び有効にするために ComPropSheet を呼び出すときに、この関数コードパラメーターを CPSFUNC_IGNORE_CPSUI_PSN_APPLY に設定します
lParam1: 1 つ以上のプロパティシートページのセットを参照する CPSUI ハンドル。このハンドルは、CPSFUNC_ADD_PCOMPROPSHEETUIの関数コード、または CPSFUNC_INSERT_PSUIPAGE の関数コードと PSUIPAGEINSERT_PROPSHEETPAGEの挿入型を使用して、comPropSheet をする呼び出しによって以前に取得されている必要があります。
lParam2: 0 以外の値を指定すると、CPSUI による CPSUICB_REASON_APPLYNOW 理由の配信が無効になります。 0 の値を指定すると、CPSUICB_REASON_APPLYNOW 理由の配信が再び有効になります。

戻り値 (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

操作が成功した場合、ComPropSheet 関数は 0 以外の値を返します。それ以外の場合は 0 を返します。

CPSFUNC_INSERT_PSUIPAGE

CPSFUNC_INSERT_PSUIPAGE 関数コードにより、ComPropSheet 関数は、プロパティシートページのセットを特定の位置に挿入します。

パラメーター (CPSFUNC_INSERT_PSUIPAGE)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、特定の位置にプロパティシートページのセットを挿入 ComPropSheet を呼び出すときに、この関数コードパラメーターを CPSFUNC_INSERT_PSUIPAGE に設定します
lParam1: 1 つまたは複数のプロパティシートページのセットへのハンドルを指定します。新しいページは、lParam2 が指す INSERTPSUIPAGE_INFO 構造体の Mode メンバー応じて、これらのページの前後に挿入されます。このハンドルは、次のいずれかの関数コードを使用して、ComPropSheet を呼び出すことによって取得されている必要があります。
- CPSFUNC_ADD_HPROPSHEETPAGE
- CPSFUNC_ADD_PCOMPROPSHEETUI
- CPSFUNC_ADD_PFNPROPSHEETUI
- CPSFUNC_ADD_PROPSHEETPAGE
- CPSFUNC_INSERT_PSUIPAGE
lParam2: 新しいページを挿入する場所と方法を記述する、INSERTPSUIPAGE_INFO 構造体へのポインター

戻り値 (CPSFUNC_INSERT_PSUIPAGE)

操作が成功した場合、ComPropSheet 関数は、挿入されたページのセットへのハンドルを返します。それ以外の場合、関数は NULL を返します。

CPSFUNC_LOAD_CPSUI_ICON

CPSFUNC_LOAD_CPSUI_ICON 関数コードにより、ComPropSheet 関数が CPSUI 提供のアイコンリソースを読み込みます。

CPSUI LoadImage を呼び出して、指定したアイコンリソースを読み込みます。

パラメーター (CPSFUNC_LOAD_CPSUI_ICON)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、この関数コードパラメーター ComPropSheet を呼び出して CPSUI 提供のアイコンリソースを読み込むときに CPSFUNC_LOAD_CPSUI_ICON に設定します
lParam1: 読み込まれる CPSUI 指定アイコンのリソース識別子。これは、Compstui.h で定義されているIDI_CPSUIプレフィックス付き識別子である必要があります。
lParam2: アイコンのサイズを表す 2 つの WORD サイズの値をピクセル単位で指定します。 LOWORD 値は幅、HIWORD 値は高さです。これらの値が 0 の場合、システムメトリックSM_CXICONとSM_CYICONが使用されます。詳細については、「GetSystemMetricsする」を参照してください。

戻り値 (CPSFUNC_LOAD_CPSUI_ICON)

操作が成功した場合、ComPropSheet 関数はアイコンハンドルを返します。それ以外の場合は NULL を返します。

CPSFUNC_LOAD_CPSUI_STRING

CPSFUNC_LOAD_CPSUI_STRING 関数コードにより、ComPropSheet 関数が CPSUI で指定された文字列リソースを読み込みます。

ComPropSheet 関数は、LoadString](/windows/win32/api/winuser/nf-winuser-loadstringw) 関数を呼び出して、指定した文字列を読み込みます。

パラメーター (CPSFUNC_LOAD_CPSUI_STRING)

hComPropSheet の: 親ハンドルをグループ化する
関数: 呼び出し元は、ComPropSheet を呼び出して CPSUI 指定の文字列リソースを読み込むときに、この関数コードパラメーターを CPSFUNC_LOAD_CPSUI_STRING に設定します
lParam1: 呼び出し元が割り当てたバッファーへの LPSTR 型ポインター。このポインターに、HIWORD(lParam2) で指定された CPSUI 指定文字列が配置されます。
lParam2: 次の 2 つの呼び出し元が指定した値が含まれています。
- LOWORD(lParam2). lParam1 が指すバッファーのサイズ (バイト単位)。
- HIWORD(lParam2). 読み込む CPSUI で指定された文字列のリソース識別子。これは、Compstui.h で定義されているIDS_CPSUIプレフィックス付き識別子である必要があります。

戻り値 (CPSFUNC_LOAD_CPSUI_STRING)

操作が成功した場合、ComPropSheet 関数は文字列の長さを返します。無効なリソース識別子が指定されている場合、関数は 0 を返します。 lParam1 が NULL または LOWORD(lParam2) の場合、関数は -1 を返します。

CPSFUNC_QUERY_DATABLOCK

CPSFUNC_QUERY_DATABLOCK 関数コードにより、ComPropSheet 関数は、CPSFUNC_SET_DATABLOCK 関数コードを使用して以前に格納されていた呼び出し元指定のデータブロックを取得します。

通常、この関数コードは、現在のページが非アクティブになる前に別のページに関連付けられている値を取得するために、_CPSUICALLBACK型指定のコールバック関数 (関数の CPSUICBPARAM 構造体に CPSUICB_REASON_SETACTIVEの Reason 値が含まれている場合) によって使用されます。

パラメーター (CPSFUNC_QUERY_DATABLOCK)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、ComPropSheet を呼び出して呼び出し元が指定したデータブロックを取得するときに、この関数コードパラメーターを CPSFUNC_QUERY_DATABLOCK に設定します
lParam1: 要求されたデータブロックを受信するバッファーのサイズと場所を識別する CPSUIDATABLOCK 構造体へのポインター
lParam2: 要求された CPSUIDATABLOCK 構造体を識別するために使用される DWORD サイズの識別子値。この値は、CPSFUNC_SET_DATABLOCK 関数コードを使用して comPropSheet をする前の呼び出しで指定されている必要があります。

戻り値 (CPSFUNC_QUERY_DATABLOCK)

操作が成功した場合、ComPropSheet 関数は、取得したデータブロックのサイズを表す値を返します。 lParam1 が NULL の場合、または指定された CPSUIDATABLOCK 構造体のメンバーの値がゼロの場合、ComPropSheet はデータブロックを格納するために必要なサイズを返します。エラーが発生した場合、関数は 0 以下の値を返します。

CPSFUNC_SET_DATABLOCK

CPSFUNC_SET_DATABLOCK 関数コードにより、ComPropSheet 関数は呼び出し元から提供されたデータブロックを格納します。この関数コードを使用して、プロパティシートページに関する情報を他のページで使用できるようにします。

通常、この関数コードは、_CPSUICALLBACK型のコールバック関数 (関数の CPSUICBPARAM 構造体に Reason 値が CPSUICB_REASON_KILLACTIVE含まれている場合) によって使用され、ページに関連付けられている値が非アクティブになる前に保存されます。

パラメーター (CPSFUNC_SET_DATABLOCK)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、呼び出し元が指定したデータブロックを格納するために comPropSheet 呼び出すときに、この関数コードパラメーターを CPSFUNC_SET_DATABLOCK に設定します
lParam1: 格納するデータブロックを記述する CPSUIDATABLOCK 構造体へのポインター
lParam2: 呼び出し元で定義された DWORD サイズの識別子値。これは、CPSFUNC_QUERY_DATABLOCK 関数コードを使用して comPropSheet をする後続の呼び出しで、指定された cpSUIDATABLOCK 構造体 を識別するために使用されます。

戻り値 (CPSFUNC_SET_DATABLOCK)

操作が成功した場合、ComPropSheet 関数は、格納されたバイト数を表す値を返します。それ以外の場合は、0 以下の値を返します。

CPSFUNC_SET_DMPUB_HIDEBITS

CPSFUNC_SET_DMPUB_HIDEBITS 関数コードにより、ComPropSheet 関数は、指定したドキュメントプロパティオプションのセットを "非表示" にして、表示されないようにします。

CPSFUNC_SET_DMPUB_HIDEBITS 関数コードは、1 つ以上のドキュメントプロパティシートオプションに OPTITEM 構造体を定義するが、オプションをユーザーが変更できない場合に使用できます。プロパティシートページは、COMPROPSHEETUI 構造体を使用して定義する必要があり、構造体の pDlgPage メンバーは CPSUI_PDLGPAGE_DOCPROP または CPSUI_PDLGPAGE_ADVDOCPROPする必要があります。

CPSFUNC_SET_DMPUB_HIDEBITS 関数コードを使用する場合は、CPSFUNC_ADD_PCOMPROPSHEETUI または CPSFUNC_INSERT_PSUIPAGE 関数コードを使用してページを作成する前に、comPropSheet をするように指定する必要があります。

パラメーター (CPSFUNC_SET_DMPUB_HIDEBITS)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、指定されたドキュメントプロパティオプションのセット 非表示にする ComPropSheet を呼び出すときに、この関数コードパラメーターを CPSFUNC_SET_DMPUB_HIDEBITS に設定します
lParam1: 非表示にするオプションを示すビット配列へのポインター。この配列は、MAKE_DMPUB_HIDEBIT(DMPub) マクロを使用して作成する必要があります。ここで、DMPub は 1 つ以上のDMPUB_プレフィックス付き定数の OR の組み合わせです。 DMPUB_プレフィックス付き定数は、OPTITEM 構造体の説明に記載されています。マクロと定数は Compstui.h で定義されています。
lParam2: 使用せず、ゼロにする必要があります

戻り値 (CPSFUNC_SET_DMPUB_HIDEBITS)

操作が成功した場合、ComPropSheet 関数は、lParam1に指定された値を返します。それ以外の場合は 0 を返します。

CPSFUNC_SET_FUSION_CONTEXT

CPSFUNC_SET_FUSION_CONTEXT は、指定したページの Fusion アクティブ化コンテキストを設定します。

ページが作成または挿入されようとしていて、その PROPSHEETPAGE 構造体にアクティブ化コンテキストを指定しない場合、親のページアクティブ化コンテキストに作成されます。

親のアクティブ化コンテキストが設定されていない場合、Compstui.dll は親の親を検索し、最上位レベルの親に達するまで、またはアクティブ化コンテキストが適切に設定された親が見つかるまで続行します。

どの親にもアクティブ化コンテキストが設定されていない場合、Compstui.dll は、PROPSHEETPAGE 構造体でアクティブ化コンテキストを指定しません。つまり、ページは、PropertySheet 関数の呼び出し元のアクティブ化コンテキストで作成されます。

パラメーター (CPSFUNC_SET_FUSION_CONTEXT)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、指定したページの Fusion アクティブ化コンテキストを設定する comPropSheet 呼び出すときに、この関数コードパラメーターを CPSFUNC_SET_FUSION_CONTEXT に設定します
lParam1: Fusion コンテキストへのハンドルを指定します。 Compstui.dll はハンドルを複製し、それを内部構造にアタッチして、呼び出し元がハンドルを保持する義務を負いません。 Compstui.dll は、Compstui.dll ハンドルが削除されたときに、渡されたコンテキストハンドルを解放します。
lParam2: 使用せず、ゼロにする必要があります

戻り値 (CPSFUNC_SET_FUSION_CONTEXT)

操作が成功した場合、ComPropSheet 関数は 0 より大きい値を返します。それ以外の場合、comPropSheet は 0 以下の値を返します。エラーの詳細については、GetLastError 関数を使用します。

CPSFUNC_SET_HSTARTPAGE

CPSFUNC_SET_HSTARTPAGE 関数コードにより、ComPropSheet 関数は、指定したプロパティシートページを関連付けられたプロパティシートのトップページとしてマークします。プロパティシートが現在表示されている場合は、指定したページがアクティブなページになります。

パラメーター (CPSFUNC_SET_HSTARTPAGE)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、指定したプロパティシートページを関連付けられたプロパティシートのトップページとしてマークするために、この関数コードパラメーター ComPropSheet を呼び出すときに CPSFUNC_SET_HSTARTPAGE に設定します
lParam1: 呼び出し元が指定した CPSUI ページハンドル。以前は、次のいずれかの関数コードを使用して comPropSheet 呼び出しによって取得されます。
- CPSFUNC_ADD_HPROPSHEETPAGE
- CPSFUNC_ADD_PCOMPROPSHEETUI
- CPSFUNC_ADD_PFNPROPSHEETUI
- CPSFUNC_ADD_PROPSHEETPAGE
- CPSFUNC_INSERT_PSUIPAGE
hComPropSheet で指定されたグループに属する 1 つのページハンドルが表す場合、CPSUI はこのページをトップページにします。

ハンドルがグループの親ハンドル (CPSFUNC_INSERT_PSUIPAGEを参照) を表す場合、lParam2 はグループのページに 0 から始まるインデックスを表し、インデックスによって表されるページがトップページになります。
lParam2: lParam1 がグループ親ハンドルを表す場合、この呼び出し元が指定した値は、グループのページへの 0 から始まるインデックスです。 lParam1 hComPropSheet で指定されたグループに属する単一ページ表す場合、このパラメーターは使用されません。 CPSFUNC_ADD_PCOMPROPSHEETUI 関数コード 使用して lParam1 で指定されたハンドルを取得し、関連付けられている COMPROPSHEETUI 構造体の pDlgPage メンバーが CPSUI_PDLGPAGE_DOCPROPに設定されている場合は、lParam2に次のいずれかの値を指定できます。
- SSP_STDPAGE1 - レイアウトページをトップページにします。
- SSP_STDPAGE2 - 用紙/品質ページをトップページにします。
- SSP_TVPAGE - [詳細設定] ページをトップページにします。

戻り値 (CPSFUNC_SET_HSTARTPAGE)

操作が成功した場合、ComPropSheet 関数は、lParam1に指定された値を返します。それ以外の場合は 0 を返します。

CPSFUNC_SET_PSUIPAGE_ICON

CPSFUNC_SET_PSUIPAGE_ICON 関数コードにより、ComPropSheet 関数は、プロパティシートページのタブに割り当てられているアイコンを追加、置換、または削除します。

lParam2 にアイコンハンドルが含まれており、lParam1 で指定されたページが現在表示されている場合、CPSUI は指定したページのタブにアイコンを追加します。アイコンが既にページに割り当てられている場合、古いアイコンは新しいアイコンに置き換えられます。 lParam2 が 0 の場合、現在のアイコン (存在する場合) は削除されます。

CPSFUNC_SET_PSUIPAGE_ICON 関数コードで指定されたすべてのアイコンについて、CPSUI はイメージサイズを 16 x 16 ピクセルに設定します。

アイコンハンドルは、LoadImage呼び出すことによって取得する必要があります。

パラメーター (CPSFUNC_SET_PSUIPAGE_ICON)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、プロパティシートページのタブに割り当てられているアイコンを追加、置換、または削除 ComPropSheet を呼び出すときに、この関数コードパラメーターを CPSFUNC_SET_PSUIPAGE_ICON に設定します
lParam1: 呼び出し元が指定した CPSUI ページハンドル。以前は、次のいずれかの関数コードを使用して comPropSheet 呼び出しによって取得されます。
- CPSFUNC_ADD_HPROPSHEETPAGE
- CPSFUNC_ADD_PROPSHEETPAGE
- CPSFUNC_INSERT_PSUIPAGE (INSERTPSUIPAGE_INFO 構造体の Type メンバーが PSUIPAGEINSERT_HPROPSHEETPAGE または PSUIPAGEINSERT_PROPSHEETPAGEに設定されている場合)
lParam2: 呼び出し元が指定したアイコンハンドル。このパラメーターを 0 に設定すると、現在のアイコンを削除できます。

戻り値 (CPSFUNC_SET_PSUIPAGE_ICON)

操作が成功した場合、ComPropSheet 関数は 1 を返します。エラーが発生した場合、または指定したページが現在表示されていない場合、関数は 0 を返します。

CPSFUNC_SET_PSUIPAGE_TITLE

CPSFUNC_SET_PSUIPAGE_TITLE 関数コードにより、ComPropSheet 関数はプロパティシートページのタブタイトルを設定します。

パラメーター (CPSFUNC_SET_PSUIPAGE_TITLE)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、プロパティシートページのタブタイトルを設定する comPropSheet 呼び出すときに、この関数コードパラメーターを CPSFUNC_SET_PSUIPAGE_TITLE に設定します
lParam1: 呼び出し元が指定した CPSUI ページハンドル。以前は、次のいずれかの関数コードを使用して comPropSheet 呼び出しによって取得されます。
- CPSFUNC_ADD_HPROPSHEETPAGE
- CPSFUNC_ADD_PROPSHEETPAGE
- CPSFUNC_INSERT_PSUIPAGE (INSERTPSUIPAGE_INFO 構造体の Type メンバーが PSUIPAGEINSERT_HPROPSHEETPAGE または PSUIPAGEINSERT_PROPSHEETPAGEに設定されています)。
lParam2: 新しいタイトルを指定する NULL で終わる文字列への呼び出し元指定ポインター

戻り値 (CPSFUNC_SET_PSUIPAGE_TITLE)

CPSFUNC_SET_RESULT

CPSFUNC_SET_RESULT 関数コードにより、ComPropSheet 関数は、指定したページとその親に関連付けられているすべての PFNPROPSHEETUI 型の関数に指定した結果値を渡します。

結果の値を設定する方法の詳細については、SETRESULT_INFO 構造体の説明を参照してください。

次の注意は、カスタム UI プロパティシートを含む Unidrv または Pscript5 ベースの IHV UI プラグインに適用され、プロパティシートで行われたユーザー設定を永続的にする必要があります。プラグインは、ComPropSheet 関数を呼び出し、関数パラメーターを CPSFUNC_SET_RESULTに設定すると、プラグインは lParam2 パラメーターを CPSUI_OKに設定する必要があります。

パラメーター (CPSFUNC_SET_RESULT)

hComPropSheet の: 親ハンドルをグループ化する
関数の: 呼び出し元は、指定したページとその親に関連付けられているすべての PFNPROPSHEETUI 型の関数に指定した結果値を渡すために、ComPropSheet を呼び出すときに、この関数コードパラメーターを CPSFUNC_SET_RESULT に設定します。
lParam1: 結果値が渡されるページへの呼び出し元指定の CPSUI ハンドル。 lParam1 が NULL の場合、CPSUI は hComPropSheet で指定値を使用します。
lParam2: 呼び出し元が指定した 32 ビット DWORD 結果値。

戻り値 (CPSFUNC_SET_RESULT)

操作が成功した場合、ComPropSheet 関数は、呼び出された PFNPROPSHEETUI 型の関数の数を返します。 lParam1 に指定されたハンドルが無効な場合、関数は -1 を返します。

必要条件

要件	価値
ターゲットプラットフォームの	デスクトップ
ヘッダー	compstui.h (Compstui.h を含む)

次の方法で共有

PFNCOMPROPSHEET コールバック関数 (compstui.h)

構文

パラメーター

戻り値

備考

ComPropSheet 関数コード

CPSFUNC_ADD_HPROPSHEETPAGE

パラメーター (CPSFUNC_ADD_HPROPSHEETPAGE)

戻り値 (CPSFUNC_ADD_HPROPSHEETPAGE)

CPSFUNC_ADD_PCOMPROPSHEETUI

パラメーター

戻り値

CPSFUNC_ADD_PFNPROPSHEETUI

パラメーター (CPSFUNC_ADD_PFNPROPSHEETUI)

戻り値 (CPSFUNC_ADD_PFNPROPSHEETUI)

CPSFUNC_ADD_PROPSHEETPAGE

パラメーター (CPSFUNC_ADD_PROPSHEETPAGE)

戻り値 (CPSFUNC_ADD_PROPSHEETPAGE)

CPSFUNC_DELETE_HCOMPROPSHEET

パラメーター (CPSFUNC_DELETE_HCOMPROPSHEET)

戻り値 (CPSFUNC_DELETE_HCOMPROPSHEET)

CPSFUNC_DO_APPLY_CPSUI

パラメーター (CPSFUNC_DO_APPLY_CPSUI)

戻り値 (CPSFUNC_DO_APPLY_CPSUI)

CPSFUNC_GET_HPSUIPAGES

パラメーター (CPSFUNC_GET_HPSUIPAGES)

戻り値 (CPSFUNC_GET_HPSUIPAGES)

CPSFUNC_GET_PAGECOUNT

パラメーター (CPSFUNC_GET_PAGECOUNT)

戻り値 (CPSFUNC_GET_PAGECOUNT)

CPSFUNC_GET_PFNPROPSHEETUI_ICON

パラメーター (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

戻り値 (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

CPSFUNC_IGNORE_CPSUI_PSN_APPLY

パラメーター (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

戻り値 (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

CPSFUNC_INSERT_PSUIPAGE

パラメーター (CPSFUNC_INSERT_PSUIPAGE)

戻り値 (CPSFUNC_INSERT_PSUIPAGE)

CPSFUNC_LOAD_CPSUI_ICON

パラメーター (CPSFUNC_LOAD_CPSUI_ICON)

戻り値 (CPSFUNC_LOAD_CPSUI_ICON)

CPSFUNC_LOAD_CPSUI_STRING

パラメーター (CPSFUNC_LOAD_CPSUI_STRING)

戻り値 (CPSFUNC_LOAD_CPSUI_STRING)

CPSFUNC_QUERY_DATABLOCK

パラメーター (CPSFUNC_QUERY_DATABLOCK)

戻り値 (CPSFUNC_QUERY_DATABLOCK)

CPSFUNC_SET_DATABLOCK

パラメーター (CPSFUNC_SET_DATABLOCK)

戻り値 (CPSFUNC_SET_DATABLOCK)

CPSFUNC_SET_DMPUB_HIDEBITS

パラメーター (CPSFUNC_SET_DMPUB_HIDEBITS)

戻り値 (CPSFUNC_SET_DMPUB_HIDEBITS)

CPSFUNC_SET_FUSION_CONTEXT

パラメーター (CPSFUNC_SET_FUSION_CONTEXT)

戻り値 (CPSFUNC_SET_FUSION_CONTEXT)

CPSFUNC_SET_HSTARTPAGE

パラメーター (CPSFUNC_SET_HSTARTPAGE)

戻り値 (CPSFUNC_SET_HSTARTPAGE)

CPSFUNC_SET_PSUIPAGE_ICON

パラメーター (CPSFUNC_SET_PSUIPAGE_ICON)

戻り値 (CPSFUNC_SET_PSUIPAGE_ICON)

CPSFUNC_SET_PSUIPAGE_TITLE

パラメーター (CPSFUNC_SET_PSUIPAGE_TITLE)

戻り値 (CPSFUNC_SET_PSUIPAGE_TITLE)

CPSFUNC_SET_RESULT

パラメーター (CPSFUNC_SET_RESULT)

戻り値 (CPSFUNC_SET_RESULT)

必要条件

フィードバック

その他のリソース