| description | ms.assetid | ms.tgt_platform | title | ms.topic | ms.date | topic_type | api_name | api_type | api_location | |
|---|---|---|---|---|---|---|---|---|---|---|
Describes document conventions for reading WMI Scripting API topics. |
889e6322-96f6-4a24-a084-e3b7bfa94a40 |
multiple |
Document Conventions for the Scripting API |
article |
05/31/2018 |
|
The Scripting API for WMI reference uses the following document conventions:
- Parameter types are defined using a prefix: b (Boolean), str (string), I (integer), obj (Automation object), var (Variant).
- Optional parameters are placed in square brackets with their default values shown by assignment.
- In the case of object parameters, the characters after the "obj" prefix indicate the type of object expected.
| Object parameter | Object type |
|---|---|
| WbemDatetime | SWbemDateTime |
| WbemEventSource | SWbemEventSource |
| WbemLocator | SWbemLocator |
| WbemMethod | SWbemMethod |
| WbemMethodSet | SWbemMethodSet |
| WbemNamedValueSet | SWbemNamedValueSet |
| WbemObject | SWbemObject |
| WbemObjectEx | SWbemObjectEx |
| WbemObjectPath | SWbemObjectPath |
| WbemObjectSet | SWbemObjectSet |
| WbemPrivilege | SWbemPrivilege |
| WbemPrivilegeSet | SWbemPrivilegeSet |
| WbemProperty | SWbemProperty |
| WbemPropertySet | SWbemPropertySet |
| WbemQualifier | SWbemQualifier |
| WbemQualifierSet | SWbemQualifierSet |
| WbemRefreshableItem | SWbemRefreshableItem |
| WbemRefresher | SWbemRefresher |
| WbemServices | SWbemServices |
| WbemServicesEx | SWbemServicesEx |
For example, the following code shows how to name variables for different types of objects:
strComputerName ' a string value for a computer name
bStatusFlag ' a boolean value used for a status
objServices ' an object value used to store an SWbemServices value