Class: WMI::CIM_USBDevice

Inherits:
Base
  • Object
show all
Defined in:
lib/CIM_USBDevice.rb

Overview

USB デバイスの管理特性です。

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

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)

デバイスの利用可能性と状態です。

 

Returns:

  • (uint16)

    Availability



85
86
87
# File 'lib/CIM_USBDevice.rb', line 85

def Availability
  @Availability
end

- (string) Caption (readonly)

Caption プロパティは、オブジェクトについての簡単な説明 (1 行分の文字列) です。

Returns:

  • (string)

    Caption



90
91
92
# File 'lib/CIM_USBDevice.rb', line 90

def Caption
  @Caption
end

- (uint32) ConfigManagerErrorCode (readonly)

Win32 構成マネージャのエラー コードを示します。

 

Returns:

  • (uint32)

    ConfigManagerErrorCode



168
169
170
# File 'lib/CIM_USBDevice.rb', line 168

def ConfigManagerErrorCode
  @ConfigManagerErrorCode
end

- (boolean) ConfigManagerUserConfig (readonly)

デバイスがユーザー定義の構成を使用しているかどうかを示します。

Returns:

  • (boolean)

    ConfigManagerUserConfig



173
174
175
# File 'lib/CIM_USBDevice.rb', line 173

def ConfigManagerUserConfig
  @ConfigManagerUserConfig
end

- (string) CreationClassName (readonly)

CreationClassName は、インスタンスの作成で使用されるクラス名、またはサブクラス名を示します。

 

Returns:

  • (string)

    CreationClassName



179
180
181
# File 'lib/CIM_USBDevice.rb', line 179

def CreationClassName
  @CreationClassName
end

- (string) Description (readonly)

Description プロパティでオブジェクトの説明が提供されます。

Returns:

  • (string)

    Description



199
200
201
# File 'lib/CIM_USBDevice.rb', line 199

def Description
  @Description
end

- (string) DeviceID (readonly)

DeviceID は論理デバイスを一意に名前付けするためのアドレス、またはほかの識別情報です。

Returns:

  • (string)

    DeviceID



204
205
206
# File 'lib/CIM_USBDevice.rb', line 204

def DeviceID
  @DeviceID
end

- (boolean) ErrorCleared (readonly)

ErrorCleared は LastErrorCode プロパティで報告されたエラーが現在は消去されていることを示すブール値のプロパティです。

Returns:

  • (boolean)

    ErrorCleared



209
210
211
# File 'lib/CIM_USBDevice.rb', line 209

def ErrorCleared
  @ErrorCleared
end

- (string) ErrorDescription (readonly)

ErrorDescription は LastErrorCode プロパティで記録されたエラーに関する情報および実行される可能性がある修正の情報を提供する自由形式の文字列です。

Returns:

  • (string)

    ErrorDescription



214
215
216
# File 'lib/CIM_USBDevice.rb', line 214

def ErrorDescription
  @ErrorDescription
end

- (datetime) InstallDate (readonly)

InstallDate プロパティは、オブジェクトがインストールされた日時を示す値です。

 

Returns:

  • (datetime)

    InstallDate



220
221
222
# File 'lib/CIM_USBDevice.rb', line 220

def InstallDate
  @InstallDate
end

- (uint32) LastErrorCode (readonly)

論理デバイスで報告されたエラー コードが LastErrorCode によってキャプチャされます。

Returns:

  • (uint32)

    LastErrorCode



225
226
227
# File 'lib/CIM_USBDevice.rb', line 225

def LastErrorCode
  @LastErrorCode
end

- (string) Name (readonly)

Name プロパティで、オブジェクトを認識するラベルを定義します。

 

Returns:

  • (string)

    Name



231
232
233
# File 'lib/CIM_USBDevice.rb', line 231

def Name
  @Name
end

- (string) PNPDeviceID (readonly)

論理デバイスの Win32 プラグ アンド プレイ デバイス ID を示します。

 

Returns:

  • (string)

    PNPDeviceID



242
243
244
# File 'lib/CIM_USBDevice.rb', line 242

def PNPDeviceID
  @PNPDeviceID
end

- (uint16) PowerManagementCapabilities (readonly)

論理デバイスの特定の電源関連機能を示します。

 0="不明"

Returns:

  • (uint16)

    PowerManagementCapabilities



253
254
255
# File 'lib/CIM_USBDevice.rb', line 253

def PowerManagementCapabilities
  @PowerManagementCapabilities
end

- (boolean) PowerManagementSupported (readonly)

デバイスを電源管理できることを示すブール値です - 例、省電力状態にする。

 

Returns:

  • (boolean)

    PowerManagementSupported



261
262
263
# File 'lib/CIM_USBDevice.rb', line 261

def PowerManagementSupported
  @PowerManagementSupported
end

- (string) Status (readonly)

Status プロパティはオブジェクトの現在の状態を示す文字列です。

 

Returns:

  • (string)

    Status



279
280
281
# File 'lib/CIM_USBDevice.rb', line 279

def Status
  @Status
end

- (uint16) StatusInfo (readonly)

StatusInfo は、論理デバイスが有効 (値 = 3)、無効 (値 = 4) またはその他 (1) または不明 (2) 状態であるかどうかを示す文字列です。

 

Returns:

  • (uint16)

    StatusInfo



285
286
287
# File 'lib/CIM_USBDevice.rb', line 285

def StatusInfo
  @StatusInfo
end

- (string) SystemCreationClassName (readonly)

スコーピング システムの CreationClassName です。

Returns:

  • (string)

    SystemCreationClassName



296
297
298
# File 'lib/CIM_USBDevice.rb', line 296

def SystemCreationClassName
  @SystemCreationClassName
end

- (string) SystemName (readonly)

スコーピング システムの名前です。

Returns:

  • (string)

    SystemName



301
302
303
# File 'lib/CIM_USBDevice.rb', line 301

def SystemName
  @SystemName
end

Instance Method Details

- (uint32) GetDescriptor(RequestIndex, RequestLength, RequestType, RequestValue)

入力パラメータによって指定されているように、このメソッドは USBDevice 記述子を返します。 各パラメータについてはここに簡単に記述されています。 詳細はそれぞれの修飾子の一覧にあります。 RequestType は受信者を指定しているとともに、要求が標準、クラス、またはベンダ固有の情報のためなのかを定義する入力パラメータです。 RequestValue は USB 記述子の種類とインデックスを定義する入力パラメータです。 RequestIndex は文字列の記述子を返すために使用されている言語を表す入力パラメータです。 RequestLength は入力と出力の両方のパラメータです。 返されるべき記述子の長さ (入力の)、およびバッファ パラメータに実際に返された長さを指定します (出力の)。 バッファは記述子データを含んでいる出力パラメータです。 GetDescriptor メソッドは USB 記述子が正常に返された場合は、整数値 0 を返します。 要求がサポートされていない場合は 1 を、ほかのすべての値はエラーを示します。

In サブクラス、可能な返信コードのセットはメソッド上の ValueMap 修飾子を使って指定することも可能です。 ValueMap に含まれる文字列は ’変換済み’ です。 値の配置修飾子としてサブクラスで指定される場合もあります。

Parameters:

  • (uint16, #read) RequestIndex

    RequestIndex によって、記述子データの文字列が返されている時に USBDevice に使用されている 2 バイト言語 ID コードが定義されます。 通常は、文字列ではない記述子にはバラメータは 0 です。 詳細情報については USB 指定を参照してください。

  • (uint16, #read) RequestLength

    入力では、RequestLength は返されるべき記述子の長さです (8 進数)。 この値が実際の記述子の長さよりも短い場合は、要求された長さだけが返されます。 実際の長さよりも長い場合は、実際の長さが返されます。 出力では、このバラメータが、返されているバッファの長さです (8 進数)。 要求された記述子が存在しない場合はこのバラメータの内容は未定義です。

  • (uint8, #read) RequestType

    RequestType がビット - マップされて、記述子の要求の種類と受信者が識別されます。 要求の種類は ’標準’、’クラス’、または ’ベンダ固有’ の可能性があります。 受信者は ’デバイス’、’インターフェイス’、’エンドポイント’、または ’その他’ の可能性があります。 それぞれのビットに適切な値については USB 指定を参照してください。

  • (uint16, #read) RequestValue

    RequestValue には記述子の種類が高バイト数で、記述子のインデックス (例: インデックスまたは記述子配列へのオフセット) が低バイト数で含まれています。 詳細情報については USB 指定を参照してください。

  • (uint8, #write) Buffer

    バッファによって要求された記述子の情報が返されます。 記述子が存在しない場合は、バッファの内容は未定義です。

  • (uint16, #write) RequestLength

    入力では、RequestLength は返されるべき記述子の長さです (8 進数)。 この値が実際の記述子の長さよりも短い場合は、要求された長さだけが返されます。 実際の長さよりも長い場合は、実際の長さが返されます。 出力では、このバラメータが、返されているバッファの長さです (8 進数)。 要求された記述子が存在しない場合はこのバラメータの内容は未定義です。

Returns:

  • (uint32)


74
75
# File 'lib/CIM_USBDevice.rb', line 74

def GetDescriptor RequestIndex, RequestLength, RequestType, RequestValue
end

- (uint32) Reset

論理デバイスのリセットを要求します。 要求が正常に実行された場合、返される値は 0 で、要求がサポートされない場合は 1 です。 また、エラーが発生した場合は、ほかの値となります。

Returns:

  • (uint32)


25
26
# File 'lib/CIM_USBDevice.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 

値の配置修飾子としてサブクラスで指定される場合もあります。

Parameters:

  • (uint16, #read) PowerState
  • (datetime, #read) Time

Returns:

  • (uint32)


17
18
# File 'lib/CIM_USBDevice.rb', line 17

def SetPowerState PowerState, Time
end