XNetworkingQuerySecurityInformationForUrlAsyncResult

Article
2025-04-28

Gets the results from the XNetworkingQuerySecurityInformationForUrlAsync function.

Syntax

HRESULT XNetworkingQuerySecurityInformationForUrlAsyncResult(
         XAsyncBlock* asyncBlock,
         size_t securityInformationBufferByteCount,
         size_t* securityInformationBufferByteCountUsed,
         uint8_t* securityInformationBuffer,
         XNetworkingSecurityInformation** securityInformation
)

Parameters

asyncBlock _Inout_
Type: XAsyncBlock*

Pointer to the XAsyncBlock that was passed to the XNetworkingQuerySecurityInformationForUrlAsync function.

securityInformationBufferByteCount _In_
Type: size_t

The size, in bytes, to allocate for the results buffer. This data is obtained by calling XNetworkingQuerySecurityInformationForUrlAsyncResultSize. Alternatively, if you have pre-allocated a large results buffer, you can pass in the size of the pre-allocated buffer.

securityInformationBufferByteCountUsed _Out_opt_
Type: size_t*

Pointer to the size, in bytes, of the actual results buffer.

securityInformationBuffer _Out_writes_bytes_to_(securityInformationBufferByteCount,*securityInformationBufferByteCountUsed)
Type: uint8_t*

Pointer to the buffer that contains the thumbprint results.

securityInformation _Outptr_
Type: XNetworkingSecurityInformation**

Pointer to the list of certificate thumbprints returned from the Network Security Allow List (NSAL).

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

This function gets the results from the XNetworkingQuerySecurityInformationForUrlAsync function. Its pointers determine the size in bytes allocated to the results buffer, actual results of the buffer byte size, the buffer that contains the thumbprint results, and the list of certificate thumbprints returned from the NSAL.

The buffer is the underlying buffer used by all the pointers in the security information structure pointer. The title should keep the buffer valid as long as it is using the security information structure pointer. Freeing and cleaning up the buffer also cleans up all memory used by the security information structure pointer. For network information in Microsoft Game Development Kit (GDK) titles, see Retrieving Network Information.

This method interrogates the local state within the calling process and returns quickly, so it is safe to call from time-sensitive contexts.

Requirements

Header: XNetworking.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

Share via