Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 3.93 KB

nf-portcls-pcregistersubdevice.md

File metadata and controls

94 lines (63 loc) · 3.93 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:portcls.PcRegisterSubdevice
PcRegisterSubdevice function (portcls.h)
The PcRegisterSubdevice function registers a subdevice to make it available for use by clients.
audio\pcregistersubdevice.htm
audio
05/08/2018
PcRegisterSubdevice function
PcRegisterSubdevice, PcRegisterSubdevice function [Audio Devices], audio.pcregistersubdevice, audpc-routines_ba884bcc-8193-4434-9747-d2bce0156eb8.xml, portcls/PcRegisterSubdevice
portcls.h
Portcls.h
Universal
The PortCls system driver implements the PcRegisterSubdevice function in Microsoft Windows 98/Me and in Windows 2000 and later operating systems.
Portcls.lib
PASSIVE_LEVEL
Windows
PcRegisterSubdevice
portcls/PcRegisterSubdevice
APIRef
kbSyntax
LibDef
Portcls.lib
Portcls.dll
PcRegisterSubdevice

PcRegisterSubdevice function

-description

The PcRegisterSubdevice function registers a subdevice to make it available for use by clients.

-parameters

-param DeviceObject [in]

Pointer to the adapter driver's device object. This is a system structure of type DEVICE_OBJECT.

-param Name [in]

Pointer to a null-terminated Unicode string that specifies the name of the subdevice. The string buffer that the Name parameter points to must remain valid for the lifetime of the device object. The string contains a short name that distinguishes the subdevice from any other subdevices registered on the same device. Each of the device's subdevices must have a unique name.

-param Unknown [in]

Pointer to the IPort interface of the port driver object that is bound to the subdevice.

-returns

PcRegisterSubdevice returns STATUS_SUCCESS if the call was successful. Otherwise, it returns an appropriate error code.

-remarks

The function registers the device interface instance for a filter object that represents a subdevice on an audio adapter. The I/O manager appends the string specified by the Name parameter to the reference string that it uses to identify the instance. The modified reference string is useful for distinguishing among the subdevices in the audio adapter. For more information about reference strings, see IoRegisterDeviceInterface.

For more information about the role of the PcRegisterSubdevice function in registering a subdevice, see Subdevice Creation.

An adapter driver can call the IUnregisterSubdevice::UnregisterSubdevice method to delete the registration of a physical connection that was registered by a previous call to PcRegisterSubdevice. For more information, see Dynamic Audio Subdevices.

-see-also

DEVICE_OBJECT

IPort

IUnregisterSubdevice::UnregisterSubdevice

IoRegisterDeviceInterface