ComDBClaimPort 関数 (msports.h)

  • [アーティクル]

ComDBClaimPort は、未使用の COM ポート番号を COM ポート データベースで "使用中" としてログに記録します。

構文

LONG ComDBClaimPort(
  [in]            HCOMDB HComDB,
  [in]            DWORD  ComNumber,
  [in]            BOOL   ForceClaim,
  [out, optional] PBOOL  Forced
);

パラメーター

[in] HComDB

ComDBOpen によって返される COM ポート データベースへのハンドル。

[in] ComNumber

呼び出し元が要求を試みる COM ポート番号を指定します。 ポート番号は、1 ~ COMDB_MAX_PORTS_ARBITRATEDの範囲の整数です。

[in] ForceClaim

内部使用専用に予約されています。

[out, optional] Forced

内部使用専用に予約されています。

戻り値

ComDBClaimPort は 、次のいずれかの状態値を返します。

リターン コード 説明
ERROR_SUCCESS
 COM ポート番号が使用されておらず、"使用中" としてログに記録されるようになりました。
ERROR_CANTWRITE
 ルーチンがデータベースに書き込めませんでした。
ERROR_INVALID_PARAMETER
 次のいずれかが true です。COM ポート データベースに対する指定されたハンドルが無効です。 指定したポート番号がCOMDB_MAX_PORTS_ARBITRATEDを超えています。
ERROR_NOT_CONNECTED
 ルーチンがデータベースにアクセスできませんでした。 詳細なエラー情報を得るには、GetLastError を呼び出します。
ERROR_SHARING_VIOLATION
 指定されたポート番号は既に使用されています。
ERROR_Xxx
 内部エラーが発生しました。 GetLastError を呼び出して、拡張エラー情報を取得します。

注釈

COM ポート データベースで COM ポート番号を要求すると、ポート番号が "使用中" としてログに記録されます。 データベースには、ポート番号を要求する呼び出し元またはデバイスに関する情報は含まれていないことに注意してください。

ComDBClaimPort は ユーザー モードで実行されます。

詳細については、「 COM ポート番号の取得と解放」を参照してください。

要件

要件 値
対象プラットフォーム デスクトップ
Header msports.h (Msports.h を含む)
Library Msports.lib
[DLL] Msports.dll

こちらもご覧ください

ComDBClaimNextFreePort

ComDBReleasePort