StorPortGetLogicalProcessorRelationship routine

The StorPortGetLogicalProcessorRelationship routine returns relationship information for one or more specified types. These types include groups, physical packages, and nodes in the host system. The information that is returned includes processor affinity masks that are composed of the logical processors in the host system. These logical processors share the specified relationship types.

Syntax


ULONG StorPortGetLogicalProcessorRelationship(
  _In_     PVOID                                    HwDeviceExtension,
  _In_opt_ PPROCESSOR_NUMBER                        ProcessorNumber,
  _In_     LOGICAL_PROCESSOR_RELATIONSHIP           RelationshipType,
  _Out_    PSYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX Information,
  _Inout_  PULONG                                   Length
);

Parameters

HwDeviceExtension [in]

A pointer to the hardware device extension for the host bus adapter (HBA).

ProcessorNumber [in, optional]

An optional pointer to a processor number for which relationships are to be returned. If this parameter is not provided, information about all processors is returned.

RelationshipType [in]

The type of relationship to be returned.

Information [out]

A pointer to a buffer that receives the specified information.

Length [in, out]

A pointer to the length of the information buffer, in bytes. Upon return, this value receives the number of bytes that are populated with relationship information.

Return value

The StorPortGetLogicalProcessorRelationshiproutine returns one of the following status codes:

Return codeDescription
STOR_STATUS_NOT_IMPLEMENTED

This function is not implemented on the active operating system.

STOR_STATUS_SUCCESS

The operation was successful.

STOR_STATUS_INVALID_PARAMETER

The operation fails with this return value if one or more of the parameters are invalid, for example, if Information is set to NULL.

STOR_STATUS_BUFFER_TOO_SMALL

The operation fails with this return value if one or more of the parameters are invalid, for example, if the supplied buffer is not large enough to hold the requested information.

 

Requirements

Target platform

Version

Available in Windows 7 and later versions of the Windows operating systems.

Header

Storport.h (include Storport.h)

IRQL

<=DISPATCH_LEVEL

DDI compliance rules

StorPortIrql

 

 

Send comments about this topic to Microsoft

Show: