EN
Este conteúdo não está disponível em seu idioma, mas aqui está a versão em inglês.

MI_Class_GetElement function

Gets all details of a specified named element from a class.

Syntax


 MI_INLINE MI_Result MI_Class_GetElement(
  _In_       const MI_Class *self,
  _In_z_ const MI_Char *name,
  _Out_opt_  MI_Value *value,
  _Out_opt_  MI_Boolean *valueExists,
  _Out_opt_  MI_Type *type,
  _Outptr_opt_result_maybenull_z_ MI_Char **referenceClass,
  _Out_opt_  MI_QualifierSet *qualifierSet,
  _Out_opt_  MI_Uint32 *flags,
  _Out_opt_  MI_Uint32 *index
);

Parameters

self [in]

A pointer to a class object from which the element is to be retrieved.

name

A pointer to the name of the element to be retrieved.

value [out, optional]

A pointer to the variable to receive the returned default value for the element. The value is valid for the lifetime of the class object; the value does not need to be deleted. This parameter is optional. If this information is not needed, pass NULL for this parameter. If this parameter is not NULL, valueExists must not be NULL. If the returned value of valueExists is MI_FALSE, then there is no default value.

valueExists [out, optional]

A pointer to a variable that receives the returned Boolean value that indicates whether a default value exits for the specified element. The parameter is MI_TRUE if a default value exits; otherwise, MI_FALSE. If this information is not needed, pass NULL for this parameter.

type [out, optional]

A pointer to a variable that receives the returned value of the MI_Type enumeration that specifies the data type. If this information is not needed, pass NULL for this parameter.

referenceClass

The class of the reference (if the element is a strongly typed reference) or the class name (if the element is a strongly typed embedded instance).

qualifierSet [out, optional]

A pointer to a variable to receive the returned element qualifier set. This parameter is optional. The memory associated with the qualifier set is valid until the class object is deleted. When you have finished using the class qualifier set, delete the class object by calling the MI_Class_Delete function. If this information is not needed, pass NULL for this parameter.

flags [out, optional]

A pointer to the variable to receive the returned flag values that describe various aspects of the element. This parameter is optional. The returned flag values can be any combination of the following MI_FLAG_* values, with the exception of certain groups of mutually exclusive flags.

ValueMeaning
MI_FLAG_ABSTRACT
131072 (0x20000)

A class flag that indicates that the class is abstract. This flag is applicable only when used in conjunction with the MI_FLAG_CLASS flag, and the flag is mutually exclusive with the MI_FLAG_TERMINAL flag.

MI_FLAG_ADOPT
2147483648 (0x80000000)

A property flag used while adding and setting properties on an MI_Instance structure to indicate that the instance will adopt the pointer and will be responsible for deleting it. This flag is mutually exclusive with the MI_FLAG_BORROW flag.

MI_FLAG_ANY
127 (0x7F)

A bitmask used to filter out these CIM meta-type (qualifier scope) flags.

  • MI_FLAG_CLASS
  • MI_FLAG_METHOD
  • MI_FLAG_PROPERTY
  • MI_FLAG_PARAMETER
  • MI_FLAG_ASSOCIATION
  • MI_FLAG_INDICATION
  • MI_FLAG_REFERENCE
MI_FLAG_ASSOCIATION
16 (0x10)

A CIM meta-type used in the MI_ClassDecl structure to indicate that a class structure is also an association class structure. This flag is mutually exclusive with other CIM meta-type (qualifier scope) flags.

MI_FLAG_BORROW
1073741824 (0x40000000)

A property flag used while adding and setting properties on an MI_Instance structure to indicate that the instance will not copy the value. The value must stay valid until the instance is deleted. This flag is mutually exclusive with the MI_FLAG_ADOPT flag.

MI_FLAG_CLASS
1 (0x1)

A CIM meta-type used in the MI_ClassDecl structure to indicate a structure describing a class. This flag is mutually exclusive with other CIM meta-type (qualifier scope) flags.

MI_FLAG_DISABLEOVERRIDE
256 (0x100)

A qualifier flag flavor to indicate that the qualifier cannot be overridden. This flag is mutually exclusive with the MI_FLAG_ENABLEOVERRIDE flag.

MI_FLAG_ENABLEOVERRIDE
128 (0x80)

A qualifier flag flavor to indicate that the qualifier can be overridden. This flag is mutually exclusive with the MI_FLAG_DISABLEOVERRIDE flag.

MI_FLAG_EXPENSIVE
524288 (0x80000)

A property flag that indicates the property is expensive. A provider does not need to supply expensive properties unless the client asks for it, although most engines and clients do not support this concept and all properties are always returned. This flag is applicable only when used in conjunction with the MI_FLAG_PROPERTY flag.

MI_FLAG_IN
8192 (0x2000)

A parameter flag that indicates that the parameter is of type In and is passed into the method. This flag is applicable only when used in conjunction with the MI_FLAG_PARAMETER flag.

MI_FLAG_INDICATION
32 (0x20)

A CIM meta-type used in the MI_ClassDecl structure to indicate that a class structure is also an indication class structure. This flag is mutually exclusive with other CIM meta-type (qualifier scope) flags.

MI_FLAG_KEY
4096 (0x1000)

A property flag that indicates that the element is a key property. This flag is applicable only when used in conjunction with the MI_FLAG_PROPERTY flag.

MI_FLAG_METHOD
2 (0x2)

A CIM meta-type used in the MI_MethodDecl structure to indicate a structure describing a method. This flag is mutually exclusive with other CIM meta-type (qualifier scope) flags.

MI_FLAG_NOT_MODIFIED
33554432 (0x2000000)

A flag that indicates that the property is not modified.

MI_FLAG_NULL
536870912 (0x20000000)

A flag that indicates that a property value or method parameter value is null.

MI_FLAG_OUT
16384 (0x4000)

A parameter flag that indicates that the parameter is of type Out and is returned from the method. This flag is applicable only when used in conjunction with the MI_FLAG_PARAMETER flag.

MI_FLAG_PARAMETER
8 (0x8)

A CIM meta-type used in the MI_ParameterDecl structure to indicate a structure describing a parameter. This flag is mutually exclusive with other CIM meta-type (qualifier scope) flags.

MI_FLAG_PROPERTY
4 (0x4)

A CIM meta-type used in the MI_PropertyDecl structure to indicate a structure describing a property. This flag is mutually exclusive with other CIM meta-type (qualifier scope) flags.

MI_FLAG_READONLY
2097152 (0x200000)

A property flag that indicates that the property can only be read and cannot be written to. This flag is applicable only when used in conjunction with the MI_FLAG_PROPERTY flag.

MI_FLAG_REFERENCE
64 (0x40)

A CIM meta-type used in the MI_QualifierDecl structure in the scope field to indicate a structure describing a pointer to other instances. This flag is mutually exclusive with other CIM meta-type (qualifier scope) flags.

MI_FLAG_REQUIRED
32768 (0x8000)

A parameter flag that indicates that the parameter must be specified. This flag is applicable only when used in conjunction with the MI_FLAG_PARAMETER flag.

MI_FLAG_RESTRICTED
512 (0x200)

A qualifier flavor that states that the qualifier will not be propagated to a derived class. The qualifier applies only to the class in which it is declared. This flag is mutually exclusive with the MI_FLAG_TOSUBCLASS flag.

MI_FLAG_STATIC
65536 (0x10000)

A flag that is used on methods to indicate that the element is static and does not need an instance specifying the key to invoke it.

MI_FLAG_STREAM
1048576 (0x100000)

A flag that indicates that a method parameter will be streamed back to the client from the provider. This flag is applicable only when used in conjunction with the MI_FLAG_PARAMETER flag.

MI_FLAG_TERMINAL
262144 (0x40000)

A class flag that indicates that the class cannot be derived from. This flag is applicable only when used in conjunction with the MI_FLAG_CLASS flag, and the flag is mutually exclusive with the MI_FLAG_ABSTRACT flag.

MI_FLAG_TOSUBCLASS
1024 (0x400)

A qualifier flavor that states that the class qualifier is inherited automatically by any subclass. This flag is mutually exclusive with the MI_FLAG_RESTRICTED flag.

MI_FLAG_TRANSLATABLE
2048 (0x800)

A qualifier flavor that indicates that there may be different languages associated with the element. Translatable qualifiers will be treated such that strings and values can be localized in different languages.

MI_FLAG_VERSION
469762048 (0x1C000000)

Three bits reserved by the infrastructure to handle future versioning changes.

 

index [out, optional]

A pointer to a variable to receive the index of the element within the class. If this information is not needed, pass NULL for this parameter.

Return value

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters to the function were not valid.

MI_RESULT_FAILED

Some kind of failure not covered by other MI_Result error codes.

 

Remarks

All element information is read-only. The information returned is valid until the class is deleted.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

 

 

Mostrar:
© 2014 Microsoft