Edit

Structured and domain-specific property accessors

This page contains reference entries in the Property queries API family. Each entry includes its declaration and requirements.

Context key information

EspGetPropertyContextKeyInfo

Retrieves context-key information from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyContextKeyInfo(const ESP_PROPERTY* Property, ESP_CONTEXT_KEY_INFO* 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

Memory, file, and storage values

EspGetPropertyMemoryAddressBasic

Retrieves the MemoryAddressBasic value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyMemoryAddressBasic(const ESP_PROPERTY* Property, ESP_MEMORY_ADDRESS_BASIC* 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

EspGetPropertyFileId128

Retrieves the FileId128 value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyFileId128(const ESP_PROPERTY* Property, FILE_ID_128* 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

EspGetPropertyUsn

Retrieves the Usn value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyUsn(const ESP_PROPERTY* Property, USN* 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

EspGetPropertyEaList

Retrieves the EaList value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyEaList(const ESP_PROPERTY* Property, ESP_EA_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

See also

EspGetPropertyStorageBusType

Retrieves the StorageBusType value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyStorageBusType(const ESP_PROPERTY* Property, STORAGE_BUS_TYPE* 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

EspGetPropertyDeviceType

Retrieves the DeviceType value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyDeviceType(const ESP_PROPERTY* Property, DEVICE_TYPE* 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

EspGetPropertySubsystemInformationType

Retrieves the SubsystemInformationType value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertySubsystemInformationType(const ESP_PROPERTY* Property, ESP_SUBSYSTEM_INFORMATION_TYPE* 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

EspGetPropertyFoTargetObjectType

Retrieves the FoTargetObjectType value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyFoTargetObjectType(const ESP_PROPERTY* Property, ESP_FO_TARGET_OBJECT_TYPE* 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

Security and token values

EspGetPropertySigningLevel

Retrieves the SigningLevel value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertySigningLevel(const ESP_PROPERTY* Property, SE_SIGNING_LEVEL* 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

EspGetPropertySecurityDescriptor

Retrieves the SecurityDescriptor value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertySecurityDescriptor(const ESP_PROPERTY* Property, SECURITY_DESCRIPTOR** 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

EspGetPropertyAcl

Retrieves the Acl value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyAcl(const ESP_PROPERTY* Property, ACL** 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

EspGetPropertySid

Retrieves the Sid value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertySid(const ESP_PROPERTY* Property, SID** 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

EspGetPropertyImpersonationLevel

Retrieves the ImpersonationLevel value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyImpersonationLevel(const ESP_PROPERTY* Property, SECURITY_IMPERSONATION_LEVEL* 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

EspGetPropertyTokenPrivileges

Retrieves the TokenPrivileges value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyTokenPrivileges(const ESP_PROPERTY* Property, TOKEN_PRIVILEGES** 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

EspGetPropertyTokenGroups

Retrieves the TokenGroups value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyTokenGroups(const ESP_PROPERTY* Property, TOKEN_GROUPS** 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

EspGetPropertyTokenType

Retrieves the TokenType value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyTokenType(const ESP_PROPERTY* Property, TOKEN_TYPE* 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

EspGetPropertyTokenElevationType

Retrieves the TokenElevationType value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyTokenElevationType(const ESP_PROPERTY* Property, TOKEN_ELEVATION_TYPE* 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

Transaction values

EspGetPropertyTransactionOutcome

Retrieves the TransactionOutcome value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyTransactionOutcome(const ESP_PROPERTY* Property, TRANSACTION_OUTCOME* 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

EspGetPropertyTransactionState

Retrieves the TransactionState value from an ESP_PROPERTY structure.

Syntax

inline HRESULT EspGetPropertyTransactionState(const ESP_PROPERTY* Property, TRANSACTION_STATE* 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