Class: WMI::Win32_SerialPort
Overview
Win32_SerialPort クラスは、Win32 システム上のシリアル ポートを表します。
Instance Attribute Summary (collapse)
-
- (uint16) Availability
readonly
デバイスの利用可能性と状態です。.
-
- (boolean) Binary
readonly
Binary プロパティは、シリアル ポートがバイナリ データの転送用に構成されているかどうかを示します。.
-
- (uint16) Capabilities
readonly
Capabilities プロパティにより、シリアル コントローラのチップ レベル機能が定義されます。.
-
- (string) CapabilityDescriptions
readonly
Capabilities 配列で示されるシリアル コントローラ機能に詳細な説明を提供する自由形式の文字列の配列です。.
-
- (string) Caption
readonly
Caption プロパティは、オブジェクトについての簡単な説明 (1 行分の文字列) です。.
-
- (uint32) ConfigManagerErrorCode
readonly
Win32 構成マネージャのエラー コードを示します。.
-
- (boolean) ConfigManagerUserConfig
readonly
デバイスがユーザー定義の構成を使用しているかどうかを示します。.
-
- (string) CreationClassName
readonly
CreationClassName は、インスタンスの作成で使用されるクラス名、またはサブクラス名を示します。.
-
- (string) Description
readonly
Description プロパティでオブジェクトの説明が提供されます。.
-
- (string) DeviceID
readonly
DeviceID プロパティには、シリアル ポートをシステム上のほかのデバイスと一意に識別する文字列が含まれています。.
-
- (boolean) ErrorCleared
readonly
ErrorCleared は LastErrorCode プロパティで報告されたエラーが現在は消去されていることを示すブール値のプロパティです。.
-
- (string) ErrorDescription
readonly
ErrorDescription は LastErrorCode プロパティで記録されたエラーに関する情報および実行される可能性がある修正の情報を提供する自由形式の文字列です。.
-
- (datetime) InstallDate
readonly
InstallDate プロパティは、オブジェクトがインストールされた日時を示す値です。.
-
- (uint32) LastErrorCode
readonly
論理デバイスで報告されたエラー コードが LastErrorCode によってキャプチャされます。.
-
- (uint32) MaxBaudRate
readonly
SCSIController にサポートされている最大のボー レートです (bps)。.
-
- (uint32) MaximumInputBufferSize
readonly
MaximumInputBufferSize プロパティにより、シリアル ポート ドライバの内部入力バッファの最大サイズが指定されます。.
-
- (uint32) MaximumOutputBufferSize
readonly
MaximumOutputBufferSize プロパティにより、シリアル ポート ドライバの内部出力バッファの最大サイズが指定されます。.
-
- (uint32) MaxNumberControlled
readonly
このコントローラでサポートされている直接アドレス可能なエンティティの最大数です。.
-
- (string) Name
readonly
Name プロパティで、オブジェクトを認識するラベルを定義します。.
-
- (boolean) OSAutoDiscovered
readonly
OSAutoDiscovered プロパティにより、オペレーティング システムによって自動的に発見された、このクラスのインスタンスが識別されます。.
-
- (string) PNPDeviceID
readonly
論理デバイスの Win32 プラグ アンド プレイ デバイス ID を示します。.
-
- (uint16) PowerManagementCapabilities
readonly
論理デバイスの特定の電源関連機能を示します。.
-
- (boolean) PowerManagementSupported
readonly
デバイスを電源管理できることを示すブール値です - 例、省電力状態にする。.
-
- (uint16) ProtocolSupported
readonly
制御された’ デバイスにアクセスするためにコントローラが使用するプロトコルです。.
-
- (string) ProviderType
readonly
ProviderType プロパティにより、通信プロバイダの種類が指定されます。.
-
- (boolean) SettableBaudRate
readonly
SettableBaudRate プロパティは、このシリアル ポートでボー レートを変更できるかどうかを示します。.
-
- (boolean) SettableDataBits
readonly
SettableDataBits プロパティは、データ ビットをこのシリアル ポートに設定できるかどうかを示します。.
-
- (boolean) SettableFlowControl
readonly
SettableFlowControl プロパティは、フロー制御をこのシリアル ポートに設定できるかどうかを示します。.
-
- (boolean) SettableParity
readonly
SettableParity プロパティは、パリティをこのシリアル ポートに設定できるかどうかを示します。.
-
- (boolean) SettableParityCheck
readonly
SettableParityCheck プロパティは、パリティ チェックをこのシリアル ポート (パリティ チェックがサポートされている場合) に設定できるかどうかを示します。.
-
- (boolean) SettableRLSD
readonly
SettableRLSD プロパティは、RLSD をこのシリアル ポート (受信回線信号検出プログラム (RLSD) がサポートされている場合) に設定できるかどうかを示します。.
-
- (boolean) SettableStopBits
readonly
SettableStopBits プロパティは、停止ビットをこのシリアル ポートに設定できるかどうかを示します。.
-
- (string) Status
readonly
Status プロパティはオブジェクトの現在の状態を示す文字列です。.
-
- (uint16) StatusInfo
readonly
StatusInfo は、論理デバイスが有効 (値 = 3)、無効 (値 = 4) またはその他 (1) または不明 (2) 状態であるかどうかを示す文字列です。.
-
- (boolean) Supports16BitMode
readonly
Supports16BitMode プロパティは、16 ビット モードがこのシリアル ポートでサポートされているかどうかを示します。.
-
- (boolean) SupportsDTRDSR
readonly
SupportsDTRDSR プロパティは、データ ターミナル レディ (DTR) およびデータ セット レディ (DSR) シグナルがこのシリアル ポートでサポートされているかどうかを示します。.
-
- (boolean) SupportsElapsedTimeouts
readonly
SupportsElapsedTimeouts プロパティは、経過タイムアウトがこのシリアル ポートでサポートされているかどうかを示します。.
-
- (boolean) SupportsIntTimeouts
readonly
SupportsIntTimeouts プロパティは、間隔タイムアウトがサポートされているかどうかを示します。.
-
- (boolean) SupportsParityCheck
readonly
SupportsParityCheck プロパティは、パリティ チェックがこのシリアル ポートでサポートされているかどうかを示します。.
-
- (boolean) SupportsRLSD
readonly
SupportsRLSD プロパティは、受信回線信号検出プログラム (RLSD) がこのシリアル ポートでサポートされるかどうかを示します。.
-
- (boolean) SupportsRTSCTS
readonly
SupportsRTSCTS プロパティは、Ready To Send (RTS) と Clear To Send (CTS) 信号がこのシリアル ポートでサポートされているかどうかを示します。.
-
- (boolean) SupportsSpecialCharacters
readonly
SupportsSpecialCharacters プロパティは、シリアル ポート制御文字がサポートされているかどうかを示します。.
-
- (boolean) SupportsXOnXOff
readonly
SupportsXOnXOff プロパティは、XON/XOFF フロー制御がこのシリアル ポートでサポートされているかどうかを示します。.
-
- (boolean) SupportsXOnXOffSet
readonly
SupportsXOnXOffSet プロパティは、通信プロバイダが XON/XOFF フロー制御設定の構成をサポートするかどうかを示します。.
-
- (string) SystemCreationClassName
readonly
スコーピング システムの CreationClassName です。.
-
- (string) SystemName
readonly
スコーピング システムの名前です。.
-
- (datetime) TimeOfLastReset
readonly
TimeOfLastReset プロパティは、このコントローラが最後にリセットされた日付と時刻を示します。.
Instance Method Summary (collapse)
-
- (uint32) Reset
論理デバイスのリセットを要求します。 要求が正常に実行された場合、返される値は 0 で、要求がサポートされない場合は 1 です。 また、エラーが発生した場合は、ほかの値となります。.
-
- (uint32) SetPowerState(PowerState, Time)
SetPowerState により、論理デバイスの電源状態およびデバイスがいつその状態に入るかが定義されます。 電源状態は、PowerState パラメータを次の整数値の 1 つに設定することによって指定されます: 1="通常の電力"、2="省電力- 低電力モード"、3="省電力 - スタンバイ"、4="省電力 - その他"、5="電源サイクル" または 6="電源オフ"。 時間パラメータ (5 の "Power Cycle" を除くすべての状態の変更用) は、通常の日付値または間隔値 (メソッド実行の受信時に間隔が開始される) のどちらかにいつ電源状態が設定される必要があるかを示します。 PowerState パラメータが 5 ("Power Cycle") であるとき、時間パラメータはいつデバイスが再度電源オンになるかを示します。 直ちに電源をオフにします。 成功の場合、SetPowerState は 0 を返し、指定された PowerState および要求時間がサポートされていない場合は、1 を返し、ほかのエラーが発生する場合はほかの値が返されます。 サブクラスでは、可能な返信コードのセットはメソッド上の ValueMap 修飾子を使って指定することも可能です。.
Methods inherited from Base
#AddRef, #AssociatorsAsync_, #Associators_, #Clone_, #CompareTo_, #DeleteAsync_, #Delete_, #Derivation_, #ExecMethodAsync_, #ExecMethod_, #GetIDsOfNames, #GetObjectText_, #GetText_, #GetTypeInfo, #GetTypeInfoCount, #InstancesAsync_, #Instances_, #Invoke, #Methods_, #Path_, #Properties_, #PutAsync_, #Put_, #Qualifiers_, #QueryInterface, #ReferencesAsync_, #References_, #Refresh_, #Release, #Security_, #SetFromText_, #SpawnDerivedClass_, #SpawnInstance_, #SubclassesAsync_, #Subclasses_, #SystemProperties_
Instance Attribute Details
- (uint16) Availability (readonly)
デバイスの利用可能性と状態です。
36 37 38 |
# File 'lib/Win32_SerialPort.rb', line 36 def Availability @Availability end |
- (boolean) Binary (readonly)
Binary プロパティは、シリアル ポートがバイナリ データの転送用に構成されているかどうかを示します。
Win32 API
45 46 47 |
# File 'lib/Win32_SerialPort.rb', line 45 def Binary @Binary end |
- (uint16) Capabilities (readonly)
Capabilities プロパティにより、シリアル コントローラのチップ レベル機能が定義されます。
52 53 54 |
# File 'lib/Win32_SerialPort.rb', line 52 def Capabilities @Capabilities end |
- (string) CapabilityDescriptions (readonly)
Capabilities 配列で示されるシリアル コントローラ機能に詳細な説明を提供する自由形式の文字列の配列です。
58 59 60 |
# File 'lib/Win32_SerialPort.rb', line 58 def CapabilityDescriptions @CapabilityDescriptions end |
- (string) Caption (readonly)
Caption プロパティは、オブジェクトについての簡単な説明 (1 行分の文字列) です。
63 64 65 |
# File 'lib/Win32_SerialPort.rb', line 63 def Caption @Caption end |
- (uint32) ConfigManagerErrorCode (readonly)
Win32 構成マネージャのエラー コードを示します。
136 137 138 |
# File 'lib/Win32_SerialPort.rb', line 136 def ConfigManagerErrorCode @ConfigManagerErrorCode end |
- (boolean) ConfigManagerUserConfig (readonly)
デバイスがユーザー定義の構成を使用しているかどうかを示します。
141 142 143 |
# File 'lib/Win32_SerialPort.rb', line 141 def ConfigManagerUserConfig @ConfigManagerUserConfig end |
- (string) CreationClassName (readonly)
CreationClassName は、インスタンスの作成で使用されるクラス名、またはサブクラス名を示します。
147 148 149 |
# File 'lib/Win32_SerialPort.rb', line 147 def CreationClassName @CreationClassName end |
- (string) Description (readonly)
Description プロパティでオブジェクトの説明が提供されます。
153 154 155 |
# File 'lib/Win32_SerialPort.rb', line 153 def Description @Description end |
- (string) DeviceID (readonly)
DeviceID プロパティには、シリアル ポートをシステム上のほかのデバイスと一意に識別する文字列が含まれています。
158 159 160 |
# File 'lib/Win32_SerialPort.rb', line 158 def DeviceID @DeviceID end |
- (boolean) ErrorCleared (readonly)
ErrorCleared は LastErrorCode プロパティで報告されたエラーが現在は消去されていることを示すブール値のプロパティです。
163 164 165 |
# File 'lib/Win32_SerialPort.rb', line 163 def ErrorCleared @ErrorCleared end |
- (string) ErrorDescription (readonly)
ErrorDescription は LastErrorCode プロパティで記録されたエラーに関する情報および実行される可能性がある修正の情報を提供する自由形式の文字列です。
168 169 170 |
# File 'lib/Win32_SerialPort.rb', line 168 def ErrorDescription @ErrorDescription end |
- (datetime) InstallDate (readonly)
InstallDate プロパティは、オブジェクトがインストールされた日時を示す値です。
174 175 176 |
# File 'lib/Win32_SerialPort.rb', line 174 def InstallDate @InstallDate end |
- (uint32) LastErrorCode (readonly)
論理デバイスで報告されたエラー コードが LastErrorCode によってキャプチャされます。
179 180 181 |
# File 'lib/Win32_SerialPort.rb', line 179 def LastErrorCode @LastErrorCode end |
- (uint32) MaxBaudRate (readonly)
SCSIController にサポートされている最大のボー レートです (bps)。
184 185 186 |
# File 'lib/Win32_SerialPort.rb', line 184 def MaxBaudRate @MaxBaudRate end |
- (uint32) MaximumInputBufferSize (readonly)
MaximumInputBufferSize プロパティにより、シリアル ポート ドライバの内部入力バッファの最大サイズが指定されます。
190 191 192 |
# File 'lib/Win32_SerialPort.rb', line 190 def MaximumInputBufferSize @MaximumInputBufferSize end |
- (uint32) MaximumOutputBufferSize (readonly)
MaximumOutputBufferSize プロパティにより、シリアル ポート ドライバの内部出力バッファの最大サイズが指定されます。
196 197 198 |
# File 'lib/Win32_SerialPort.rb', line 196 def MaximumOutputBufferSize @MaximumOutputBufferSize end |
- (uint32) MaxNumberControlled (readonly)
このコントローラでサポートされている直接アドレス可能なエンティティの最大数です。
202 203 204 |
# File 'lib/Win32_SerialPort.rb', line 202 def MaxNumberControlled @MaxNumberControlled end |
- (string) Name (readonly)
Name プロパティで、オブジェクトを認識するラベルを定義します。
208 209 210 |
# File 'lib/Win32_SerialPort.rb', line 208 def Name @Name end |
- (boolean) OSAutoDiscovered (readonly)
OSAutoDiscovered プロパティにより、オペレーティング システムによって自動的に発見された、このクラスのインスタンスが識別されます。
215 216 217 |
# File 'lib/Win32_SerialPort.rb', line 215 def OSAutoDiscovered @OSAutoDiscovered end |
- (string) PNPDeviceID (readonly)
論理デバイスの Win32 プラグ アンド プレイ デバイス ID を示します。
221 222 223 |
# File 'lib/Win32_SerialPort.rb', line 221 def PNPDeviceID @PNPDeviceID end |
- (uint16) PowerManagementCapabilities (readonly)
論理デバイスの特定の電源関連機能を示します。
0="不明"
232 233 234 |
# File 'lib/Win32_SerialPort.rb', line 232 def PowerManagementCapabilities @PowerManagementCapabilities end |
- (boolean) PowerManagementSupported (readonly)
デバイスを電源管理できることを示すブール値です - 例、省電力状態にする。
240 241 242 |
# File 'lib/Win32_SerialPort.rb', line 240 def PowerManagementSupported @PowerManagementSupported end |
- (uint16) ProtocolSupported (readonly)
制御された’ デバイスにアクセスするためにコントローラが使用するプロトコルです。
245 246 247 |
# File 'lib/Win32_SerialPort.rb', line 245 def ProtocolSupported @ProtocolSupported end |
- (string) ProviderType (readonly)
ProviderType プロパティにより、通信プロバイダの種類が指定されます。
250 251 252 |
# File 'lib/Win32_SerialPort.rb', line 250 def ProviderType @ProviderType end |
- (boolean) SettableBaudRate (readonly)
SettableBaudRate プロパティは、このシリアル ポートでボー レートを変更できるかどうかを示します。
258 259 260 |
# File 'lib/Win32_SerialPort.rb', line 258 def SettableBaudRate @SettableBaudRate end |
- (boolean) SettableDataBits (readonly)
SettableDataBits プロパティは、データ ビットをこのシリアル ポートに設定できるかどうかを示します。
266 267 268 |
# File 'lib/Win32_SerialPort.rb', line 266 def SettableDataBits @SettableDataBits end |
- (boolean) SettableFlowControl (readonly)
SettableFlowControl プロパティは、フロー制御をこのシリアル ポートに設定できるかどうかを示します。
274 275 276 |
# File 'lib/Win32_SerialPort.rb', line 274 def SettableFlowControl @SettableFlowControl end |
- (boolean) SettableParity (readonly)
SettableParity プロパティは、パリティをこのシリアル ポートに設定できるかどうかを示します。
282 283 284 |
# File 'lib/Win32_SerialPort.rb', line 282 def SettableParity @SettableParity end |
- (boolean) SettableParityCheck (readonly)
SettableParityCheck プロパティは、パリティ チェックをこのシリアル ポート (パリティ チェックがサポートされている場合) に設定できるかどうかを示します。
290 291 292 |
# File 'lib/Win32_SerialPort.rb', line 290 def SettableParityCheck @SettableParityCheck end |
- (boolean) SettableRLSD (readonly)
SettableRLSD プロパティは、RLSD をこのシリアル ポート (受信回線信号検出プログラム (RLSD) がサポートされている場合) に設定できるかどうかを示します。
298 299 300 |
# File 'lib/Win32_SerialPort.rb', line 298 def SettableRLSD @SettableRLSD end |
- (boolean) SettableStopBits (readonly)
SettableStopBits プロパティは、停止ビットをこのシリアル ポートに設定できるかどうかを示します。
306 307 308 |
# File 'lib/Win32_SerialPort.rb', line 306 def SettableStopBits @SettableStopBits end |
- (string) Status (readonly)
Status プロパティはオブジェクトの現在の状態を示す文字列です。
319 320 321 |
# File 'lib/Win32_SerialPort.rb', line 319 def Status @Status end |
- (uint16) StatusInfo (readonly)
StatusInfo は、論理デバイスが有効 (値 = 3)、無効 (値 = 4) またはその他 (1) または不明 (2) 状態であるかどうかを示す文字列です。
325 326 327 |
# File 'lib/Win32_SerialPort.rb', line 325 def StatusInfo @StatusInfo end |
- (boolean) Supports16BitMode (readonly)
Supports16BitMode プロパティは、16 ビット モードがこのシリアル ポートでサポートされているかどうかを示します。
333 334 335 |
# File 'lib/Win32_SerialPort.rb', line 333 def Supports16BitMode @Supports16BitMode end |
- (boolean) SupportsDTRDSR (readonly)
SupportsDTRDSR プロパティは、データ ターミナル レディ (DTR) およびデータ セット レディ (DSR) シグナルがこのシリアル ポートでサポートされているかどうかを示します。
341 342 343 |
# File 'lib/Win32_SerialPort.rb', line 341 def SupportsDTRDSR @SupportsDTRDSR end |
- (boolean) SupportsElapsedTimeouts (readonly)
SupportsElapsedTimeouts プロパティは、経過タイムアウトがこのシリアル ポートでサポートされているかどうかを示します。
350 351 352 |
# File 'lib/Win32_SerialPort.rb', line 350 def SupportsElapsedTimeouts @SupportsElapsedTimeouts end |
- (boolean) SupportsIntTimeouts (readonly)
SupportsIntTimeouts プロパティは、間隔タイムアウトがサポートされているかどうかを示します。
359 360 361 |
# File 'lib/Win32_SerialPort.rb', line 359 def SupportsIntTimeouts @SupportsIntTimeouts end |
- (boolean) SupportsParityCheck (readonly)
SupportsParityCheck プロパティは、パリティ チェックがこのシリアル ポートでサポートされているかどうかを示します。
367 368 369 |
# File 'lib/Win32_SerialPort.rb', line 367 def SupportsParityCheck @SupportsParityCheck end |
- (boolean) SupportsRLSD (readonly)
SupportsRLSD プロパティは、受信回線信号検出プログラム (RLSD) がこのシリアル ポートでサポートされるかどうかを示します。
375 376 377 |
# File 'lib/Win32_SerialPort.rb', line 375 def SupportsRLSD @SupportsRLSD end |
- (boolean) SupportsRTSCTS (readonly)
SupportsRTSCTS プロパティは、Ready To Send (RTS) と Clear To Send (CTS) 信号がこのシリアル ポートでサポートされているかどうかを示します。
383 384 385 |
# File 'lib/Win32_SerialPort.rb', line 383 def SupportsRTSCTS @SupportsRTSCTS end |
- (boolean) SupportsSpecialCharacters (readonly)
SupportsSpecialCharacters プロパティは、シリアル ポート制御文字がサポートされているかどうかを示します。
394 395 396 |
# File 'lib/Win32_SerialPort.rb', line 394 def SupportsSpecialCharacters @SupportsSpecialCharacters end |
- (boolean) SupportsXOnXOff (readonly)
SupportsXOnXOff プロパティは、XON/XOFF フロー制御がこのシリアル ポートでサポートされているかどうかを示します。
402 403 404 |
# File 'lib/Win32_SerialPort.rb', line 402 def SupportsXOnXOff @SupportsXOnXOff end |
- (boolean) SupportsXOnXOffSet (readonly)
SupportsXOnXOffSet プロパティは、通信プロバイダが XON/XOFF フロー制御設定の構成をサポートするかどうかを示します。
410 411 412 |
# File 'lib/Win32_SerialPort.rb', line 410 def SupportsXOnXOffSet @SupportsXOnXOffSet end |
- (string) SystemCreationClassName (readonly)
スコーピング システムの CreationClassName です。
416 417 418 |
# File 'lib/Win32_SerialPort.rb', line 416 def SystemCreationClassName @SystemCreationClassName end |
- (string) SystemName (readonly)
スコーピング システムの名前です。
421 422 423 |
# File 'lib/Win32_SerialPort.rb', line 421 def SystemName @SystemName end |
- (datetime) TimeOfLastReset (readonly)
TimeOfLastReset プロパティは、このコントローラが最後にリセットされた日付と時刻を示します。
427 428 429 |
# File 'lib/Win32_SerialPort.rb', line 427 def TimeOfLastReset @TimeOfLastReset end |
Instance Method Details
- (uint32) Reset
論理デバイスのリセットを要求します。 要求が正常に実行された場合、返される値は 0 で、要求がサポートされない場合は 1 です。 また、エラーが発生した場合は、ほかの値となります。
25 26 |
# File 'lib/Win32_SerialPort.rb', line 25 def Reset end |
- (uint32) SetPowerState(PowerState, Time)
SetPowerState により、論理デバイスの電源状態およびデバイスがいつその状態に入るかが定義されます。 電源状態は、PowerState パラメータを次の整数値の 1 つに設定することによって指定されます: 1="通常の電力"、2="省電力- 低電力モード"、3="省電力 - スタンバイ"、4="省電力 - その他"、5="電源サイクル" または 6="電源オフ"。 時間パラメータ (5 の "Power Cycle" を除くすべての状態の変更用) は、通常の日付値または間隔値 (メソッド実行の受信時に間隔が開始される) のどちらかにいつ電源状態が設定される必要があるかを示します。 PowerState パラメータが 5 ("Power Cycle") であるとき、時間パラメータはいつデバイスが再度電源オンになるかを示します。 直ちに電源をオフにします。 成功の場合、SetPowerState は 0 を返し、指定された PowerState および要求時間がサポートされていない場合は、1 を返し、ほかのエラーが発生する場合はほかの値が返されます。 サブクラスでは、可能な返信コードのセットはメソッド上の ValueMap 修飾子を使って指定することも可能です。
ValueMap
値の配置修飾子としてサブクラスで指定される場合もあります。
17 18 |
# File 'lib/Win32_SerialPort.rb', line 17 def SetPowerState PowerState, Time end |