Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This page contains reference entries in the Property queries API family. Each entry includes its declaration and requirements.
Errors and scalar values
EspGetPropertyError
Retrieves the property-level error stored in an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyError(const ESP_PROPERTY* Property, HRESULT* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyBool
Retrieves the Bool value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyBool(const ESP_PROPERTY* Property, BOOL* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyUint8
Retrieves the Uint8 value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyUint8(const ESP_PROPERTY* Property, UINT8* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyUint16
Retrieves the Uint16 value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyUint16(const ESP_PROPERTY* Property, UINT16* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyUint32
Retrieves the Uint32 value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyUint32(const ESP_PROPERTY* Property, UINT32* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyUint64
Retrieves the Uint64 value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyUint64(const ESP_PROPERTY* Property, UINT64* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyInt32
Retrieves the Int32 value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyInt32(const ESP_PROPERTY* Property, INT32* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyNtStatus
Retrieves the NtStatus value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyNtStatus(const ESP_PROPERTY* Property, NTSTATUS* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyFileTime
Retrieves the FileTime value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyFileTime(const ESP_PROPERTY* Property, FILETIME* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyGuid
Retrieves the Guid value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyGuid(const ESP_PROPERTY* Property, GUID* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
Strings and buffers
EspGetPropertyUnicodeString
Retrieves the UnicodeString value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyUnicodeString(const ESP_PROPERTY* Property, ESP_UNICODE_STRING* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyBuffer
Retrieves the Buffer value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyBuffer(const ESP_PROPERTY* Property, ESP_BUFFER* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |
See also
EspGetPropertyStringList
Retrieves the StringList value from an ESP_PROPERTY structure.
Syntax
inline HRESULT EspGetPropertyStringList(const ESP_PROPERTY* Property, ESP_STRING_LIST* Value);
Parameters
Property
The property to inspect.
Value
Receives the requested value when the function succeeds.
Return value
Returns S_OK if the value is retrieved successfully, E_POINTER if an argument or required property-value pointer is null, or E_INVALIDARG if the property's variant type does not match the requested value type. If the property contains an error variant, returns the stored error.
Remarks
This is an inline helper declared in espclient.h.
Requirements
| Requirement | Value |
|---|---|
| Header | espclient.h |