TCPMON Xcv コマンド

[アーティクル]
04/03/2024

このセクションでは、標準の TCP/IP ポートモニター (TCPMON) と通信するときに XcvData または XcvDataPort 関数の呼び出しで指定できるコマンドについて説明します。各コマンドは、これらの関数の呼び出しで pszDataName 文字列によって指定されます。特定のコマンドには、入力バッファーまたは出力バッファー、またはその両方が必要です。そのような関数の pInputData パラメーターと pOutputData パラメーターは、これらのバッファーのアドレスを保持します。

次の表では、各コマンドの説明と、コマンドで使用される XcvData パラメーターと XcvDataPort パラメーターの一覧を示します。なお、両方の関数に共通の hXcv パラメータや、XcvData 関数の pdwStatus パラメータは掲載していません。

AddPort コマンド

AddPort コマンドは、標準の TCP/IP ポート (LPR ポートまたは RAW TCP/IP ポートのどちらかを指定) を追加します。

XcvData パラメーター	Value
pszDataName	L"AddPort"
pInputData	PORT_DATA_1 構造体のアドレス
cbInputData	sizeof(PORT_DATA_1)
pOutputData	NULL
cbOutputData	0
pcbOutputNeeded	DWORD のアドレス

XcvData は、ポートを追加できる場合、NO_ERRORを返します。 XcvData は、通常のエラーコードに加えて、サーバー上にポートを作成するための権限が不足している場合 ERROR_ACCESS_DENIED を返します。このコマンドには SERVER_ACCESS_ADMINISTER 特権が必要です。 pInputData パラメーターが NULL の場合、関数は ERROR_INVALID_DATA を返します。 pInputData-->dwVersion が 1 に等しくない場合、関数は ERROR_INVALID_LEVEL を返します。

ConfigPort コマンド

ConfigPort コマンドは、既存の標準 TCP/IP ポートモニターポートを構成します。

XcvData パラメーター	Value
pszDataName	L"ConfigPort"
pInputData	PORT_DATA_1 構造体のアドレス
cbInputData	sizeof(PORT_DATA_1)
pOutputData	NULL
cbOutputData	0
pcbOutputNeeded	DWORD のアドレス

XcvData は、ポートを構成できる場合、NO_ERROR を返します。 XcvData は、通常のエラーコードに加えて、呼び出し元の実行権限が不足している場合、ERROR_ACCESS_DENIED を返します。このコマンドには SERVER_ACCESS_ADMINISTER 特権が必要です。 pInputData パラメーターが NULL の場合、または cbInputData の値が必要な値より小さい場合、関数は ERROR_INVALID_DATA を返します。 pInputData-->dwVersion が 1 に等しくない場合、関数は ERROR_INVALID_LEVEL を返します。

DeletePort コマンド

DeletePort コマンドは、標準の TCP/IP ポートモニターからポートを削除します。

XcvData パラメーター	Value
pszDataName	L"DeletePort"
pInputData	DELETE_PORT_DATA_1 構造体のアドレス
cbInputData	sizeof(DELETE_PORT_DATA_1)
pOutputData	NULL
cbOutputData	0
pcbOutputNeeded	DWORD のアドレス

ポートが正常に削除された場合、XcvData は NO_ERROR を返します。通常のエラーコードに加えて、呼び出し元のサーバーに対する権限が不足している場合、XcvData は ERROR_ACCESS_DENIED を返します。このコマンドには SERVER_ACCESS_ADMINISTER 特権が必要です。 pInputData パラメーターが NULL の場合、または cbInputData パラメーターが必要な値より小さい場合、関数は ERROR_INVALID_DATA を返します。 pInputData-->dwVersion が 1 に等しくない場合、関数は ERROR_INVALID_LEVEL を返します。

GetConfigInfo コマンド

GetConfigInfo コマンドは、特定のポートの構成情報を取得します。この場合、ポートを識別できるように、Xcv データハンドルは特定の標準 TCP/IP ポートモニターポートを指す必要があります。

XcvData パラメーター	Value
pszDataName	L"GetConfigInfo"
pInputData	CONFIG_INFO_DATA_1 構造体のアドレス
cbInputData	sizeof(CONFIG_INFO_DATA_1)
pOutputData	PORT_DATA_1 構造体のアドレス
cbOutputData	sizeof(PORT_DATA_1)
pcbOutputNeeded	pOutputData が指すバッファーに必要なバイト数が格納された DWORD のアドレス

ポートの構成情報を取得できる場合、XcvData は NO_ERROR を返します。 pInputData が NULL の場合、または cbInputData が必要な値より小さい場合、関数は ERROR_INVALID_DATA を返します。 pInputData-->dwVersion が 1 に等しくない場合、関数は ERROR_INVALID_LEVEL を返します。 cbOutputData が必要な値より小さい場合、この関数は pcbOutputNeeded が NULL の場合、ERROR_INVALID_PARAMETER を返し、pcbOutputNeeded が NULL 以外の場合、ERROR_INSUFFICIENT_BUFFER を返します。

HostAddress コマンド

HostAddress コマンドは、プリンターのホスト名を取得します。

XcvData パラメーター	Value
pszDataName	L"HostAddress"
pInputData	NULL
cbInputData	0
pOutputData	プリンターのホスト名が格納された、文字列受け取り型のバッファーのアドレス
cbOutputData	pOutputData が指すバッファーのサイズ
pcbOutputNeeded	pOutputData が指すバッファーに必要なバイト数が格納された DWORD のアドレス

プリンターのホストの名前を取得できる場合、XcvData は NO_ERROR を返します。 cbOutputData が必要な値より小さい場合、この関数は pcbOutputNeeded が NULL の場合、ERROR_INVALID_PARAMETER を返し、pcbOutputNeeded が NULL 以外の場合、ERROR_INSUFFICIENT_BUFFER を返します。 pOutputData が NULL の場合、関数は ERROR_INVALID_PARAMETER を返します。

IPAddress コマンド

IPAddress コマンドは、プリンターの IP アドレスを取得します。

XcvData パラメーター	Value
pszDataName	L"IPAddress"
pInputData	NULL
cbInputData	0
pOutputData	プリンターの IP アドレスが格納された、文字列受け取り型のバッファーのアドレス
cbOutputData	pOutputData が指すバッファーのサイズ
pcbOutputNeeded	pOutputData が指すバッファーに必要なバイト数が格納された DWORD のアドレス

プリンターの IP アドレスを取得できる場合、XcvData は NO_ERROR を返します。 cbOutputData が必要な値より小さい場合、この関数は pcbOutputNeeded が NULL の場合、ERROR_INVALID_PARAMETER を返し、pcbOutputNeeded が NULL 以外の場合、ERROR_INSUFFICIENT_BUFFER を返します。 pOutputData が NULL の場合、関数は ERROR_INVALID_PARAMETER を返します。

MonitorUI コマンド

MonitorUI コマンドは、TCPMON へのインターフェイスを提供するポートモニター UI DLL の名前を取得します。

XcvData パラメーター	Value
pszDataName	L"MonitorUI"
pInputData	NULL
cbInputData	0
pOutputData	ポートモニターのユーザーインターフェイス DLL の名前が格納されるバッファーのアドレス
cbOutputData	ポートモニターのユーザーインターフェイス DLL の名前を含む文字列内のバイト数
pcbOutputNeeded	pOutputData が指すバッファーに必要なバイト数が格納された DWORD のアドレス

ユーザーインターフェイス DLL の名前を取得できる場合、XcvData は NO_ERRORを返します。通常のエラーコードに加えて、呼び出し元のサーバーに対する権限が不足している場合、XcvData は ERROR_ACCESS_DENIED を返します。このコマンドには SERVER_ACCESS_ADMINISTER 特権が必要です。 cbOutputData が必要な値より小さい場合、この関数は pcbOutputNeeded が NULL の場合、ERROR_INVALID_PARAMETER を返し、pcbOutputNeeded が NULL 以外の場合、ERROR_INSUFFICIENT_BUFFER を返します。 pOutputData が NULL の場合、関数は ERROR_INVALID_PARAMETER を返します。

SNMPCommunity

SNMPCommunity コマンドは、プリンターの簡易ネットワーク管理プロトコル (SNMP) コミュニティ名を取得します。

XcvData パラメーター	Value
pszDataName	L"SNMPCommunity"
pInputData	NULL
cbInputData	0
pOutputData	プリンターの SNMP コミュニティ名が格納された、文字列受け取り型のバッファーのアドレス
cbOutputData	pOutputData パラメーターが指す文字列を格納するために必要なバッファーのサイズ
pcbOutputNeeded	pOutputData が指すバッファーに必要なバイト数が格納された DWORD のアドレス

プリンターの SNMP コミュニティ名を取得できる場合、XcvData は NO_ERROR を返します。 cbOutputData が必要な値より小さい場合、この関数は pcbOutputNeeded が NULL の場合、ERROR_INVALID_PARAMETER を返し、pcbOutputNeeded が NULL 以外の場合、ERROR_INSUFFICIENT_BUFFER を返します。 pOutputData が NULL の場合、関数は ERROR_INVALID_PARAMETER を返します。

SNMPDeviceIndex

SNMPDeviceIndex コマンドは、プリンターの簡易ネットワーク管理プロトコル (SNMP) デバイスインデックスを取得します。

XcvData パラメーター	Value
pszDataName	L"SNMPDeviceIndex"
pInputData	NULL
cbInputData	0
pOutputData	デバイスインデックスが格納されるバッファーのアドレス
cbOutputData	sizeof(DWORD)
pcbOutputNeeded	sizeof (DWORD) が格納される DWORD のアドレス

プリンターの SNMP デバイスインデックス名を取得できる場合、XcvData は NO_ERROR を返します。 cbOutputData が必要な値より小さい場合、この関数は pcbOutputNeeded が NULL の場合、ERROR_INVALID_PARAMETER を返し、pcbOutputNeeded が NULL 以外の場合、ERROR_INSUFFICIENT_BUFFER を返します。 pOutputData が NULL の場合、関数は ERROR_INVALID_PARAMETER を返します。

SNMPEnabled

SNMPEnabled コマンドは、簡易ネットワーク管理プロトコル (SNMP) が現在のデバイスに対して有効になっているかどうかを判別します。

XcvData パラメーター	Value
pszDataName	L"SNMPEnabled"
pInputData	NULL
cbInputData	0
pOutputData	DWORD 値が格納されるバッファーのアドレス
cbOutputData	sizeof(DWORD)
pcbOutputNeeded	sizeof (DWORD) が格納される DWORD のアドレス

デバイスに対して SNMP が有効になっている場合、XcvData は NO_ERROR を返します。 cbOutputData が必要な値より小さい場合、この関数は pcbOutputNeeded が NULL の場合、ERROR_INVALID_PARAMETER を返し、pcbOutputNeeded が NULL 以外の場合、ERROR_INSUFFICIENT_BUFFER を返します。 pOutputData が NULL の場合、関数は ERROR_INVALID_PARAMETER を返します。

次の方法で共有