ntddcdrm.h header
This header is used by storage. For more information, see:
ntddcdrm.h contains the following programming interfaces:
IOCTLs
| IOCTL_CDROM_CHECK_VERIFY The IOCTL_CDROM_CHECK_VERIFY IOCTL is replaced by IOCTL_STORAGE_CHECK_VERIFY In Microsoft Windows 2000 and later operating systems. |
| IOCTL_CDROM_ENABLE_STREAMING Enables or disables CDROM streaming mode on a per-handle basis for raw read and write requests. |
| IOCTL_CDROM_EXCLUSIVE_ACCESS The IOCTL_CDROM_EXCLUSIVE_ACCESS request instructs the CD-ROM class driver to:Report the access state of a CD-ROM device. |
| IOCTL_CDROM_FIND_NEW_DEVICES The IOCTL_CDROM_FIND_NEW_DEVICES IOCTL is replaced by IOCTL_STORAGE_FIND_NEW_DEVICES In Microsoft Windows 2000 and later operating systems. |
| IOCTL_CDROM_GET_CONFIGURATION Requests feature and profile information from a CD-ROM device. |
| IOCTL_CDROM_GET_CONTROL This IOCTL request is obsolete. Do not use.Determines the current audio playback mode. |
| IOCTL_CDROM_GET_DRIVE_GEOMETRY Returns information about the CD-ROM's geometry (media type, number of cylinders, tracks per cylinder, sectors per track, and bytes per sector). |
| IOCTL_CDROM_GET_DRIVE_GEOMETRY_EX Returns information about a CD-ROM's geometry (media type, number of cylinders, tracks per cylinder, sectors per track, and bytes per sector).The IOCTL_CDROM_GET_DRIVE_GEOMETRY_EX request differs from the older IOCTL_CDROM_GET_DRIVE_GEOMETRY request. |
| IOCTL_CDROM_GET_INQUIRY_DATA Returns the SCSI inquiry data for the CD-ROM device. This IOCTL can be used when a device has been exclusively locked with IOCTL_CDROM_EXCLUSIVE_ACCESS. |
| IOCTL_CDROM_GET_LAST_SESSION Queries the device for the first complete session number, the last complete session number, and the last complete session starting address. |
| IOCTL_CDROM_GET_PERFORMANCE Retrieves the supported speeds from the device. The IOCTL_CDROM_GET_PERFORMANCE I/O control request is a wrapper over the MMC command, GET PERFORMANCE. |
| IOCTL_CDROM_GET_VOLUME Determines the current volume for each of its device's audio ports. Obsolete, beginning with Windows Vista. |
| IOCTL_CDROM_LOAD_MEDIA Draws a protruding CDROM tray back into the drive. |
| IOCTL_CDROM_PAUSE_AUDIO Suspends audio play. Obsolete, beginning with Windows Vista. |
| IOCTL_CDROM_PLAY_AUDIO_MSF Plays the specified range of the media. Obsolete, beginning with Windows Vista. |
| IOCTL_CDROM_RAW_READ Reads data from the CD-ROM in raw mode. |
| IOCTL_CDROM_READ_Q_CHANNEL Returns the current position, media catalog, or ISRC track data. Reading the current position is obsolete, beginning with Windows Vista. |
| IOCTL_CDROM_READ_TOC Returns the table of contents of the media. Obsolete, beginning with Windows Vista. |
| IOCTL_CDROM_READ_TOC_EX Queries the target device for the table of contents (TOC), the program memory area (PMA), and the absolute time in pregroove (ATIP). |
| IOCTL_CDROM_RESUME_AUDIO Resumes a suspended audio operation. Obsolete, beginning with Windows Vista. |
| IOCTL_CDROM_SEEK_AUDIO_MSF Moves the heads to the specified MSF on the media. Obsolete, beginning with Windows Vista. |
| IOCTL_CDROM_SEND_OPC_INFORMATION The IOCTL_CDROM_SEND_OPC_INFORMATION control code can be used in file systems and other implementations that want to perform the Optimum Power Calibration (OPC) procedure in advance, so that the first streaming write does not have to wait for the procedure to finish. The optical drive performs the OPC procedure to determine the optimum power of the laser during write. The procedure is necessary to ensure quality, but it wears out the media and should not be performed too often. |
| IOCTL_CDROM_SET_SPEED Sets the spindle speed of the CD-ROM drive. |
| IOCTL_CDROM_SET_VOLUME Resets the volume for its device's audio ports. Obsolete, beginning with Windows Vista. |
| IOCTL_CDROM_STOP_AUDIO Ends audio play. Obsolete, beginning with Windows Vista. |
Structures
| CDROM_AUDIO_CONTROL The CDROM_AUDIO_CONTROL structure is used in conjunction with the IOCTL_CDROM_GET_CONTROL request to report the audio playback mode. |
| CDROM_EXCEPTION_PERFORMANCE_DESCRIPTOR The CDROM_EXCEPTION_PERFORMANCE_DESCRIPTOR structure indicates that the result data from the IOCTL_CDROM_GET_PERFORMANCE I/O control request is for exception conditions. |
| CDROM_EXCLUSIVE_ACCESS The CDROM_EXCLUSIVE_ACCESS structure is used with the IOCTL_CDROM_EXCLUSIVE_ACCESS request to query the access state of a CD-ROM device or to lock or unlock the device for exclusive access. |
| CDROM_EXCLUSIVE_LOCK The CDROM_EXCLUSIVE_LOCK structure is used with the IOCTL_CDROM_EXCLUSIVE_ACCESS request to lock a CD-ROM device for exclusive access. |
| CDROM_EXCLUSIVE_LOCK_STATE The CDROM_EXCLUSIVE_LOCK_STATE structure is used by the CD-ROM class driver to report the exclusive access state of a CD-ROM device. |
| CDROM_NOMINAL_PERFORMANCE_DESCRIPTOR The CDROM_NOMINAL_PERFORMANCE_DESCRIPTOR structure gives the host an approximation of logical unit performance. |
| CDROM_PERFORMANCE_HEADER The CDROM_PERFORMANCE_HEADER structure is used by the IOCTL_CDROM_GET_PERFORMANCE IOCTL to return data. When the request type is CdromPerformanceRequest, the IOCTL returns this header followed by optional descriptors. |
| CDROM_PERFORMANCE_REQUEST The CDROM_PERFORMANCE_REQUEST structure is used as an input parameter to the IOCTL_CDROM_GET_PERFORMANCE I/O control request and describes the performance data requested. |
| CDROM_PLAY_AUDIO_MSF Device control IRPs with a control code of IOCTL_CDROM_PLAY_AUDIO_MSF use this structure to play an audio CD. |
| CDROM_READ_TOC_EX When drivers query a target CD-ROM device with IOCTL_CDROM_READ_TOC_EX they must define the query with this structure. |
| CDROM_SEEK_AUDIO_MSF The CDROM_SEEK_AUDIO_MSF structure contains the minute, second, and frame that the device must seek to upon receipt of a device control IRP with a control code of IOCTL_CDROM_SEEK_AUDIO_MSF. |
| CDROM_SET_SPEED The CDROM_SET_SPEED structure is used with the IOCTL_CDROM_SET_SPEED request to set the spindle speed of a CD-ROM drive during data transfers in which no data loss is permitted. |
| CDROM_SET_STREAMING The CDROM_SET_SPEED structure is used with the IOCTL_CDROM_SET_SPEED request to set the spindle speed of a CD-ROM drive during isochronous transfers that permit some data loss. |
| CDROM_SIMPLE_OPC_INFO The CDROM_SIMPLE_OPC_INFO structure is the only input for the IOCTL_CDROM_SEND_OPC_INFORMATION I/O control code. |
| CDROM_STREAMING_CONTROL The CDROM_STREAMING_CONTROL structure is used as an input parameter to the IOCTL_CDROM_ENABLE_STREAMING IOCTL. |
| CDROM_SUB_Q_DATA_FORMAT The CDROM_SUB_Q_DATA_FORMAT structure is used with device control IRPs of type IOCTL_CDROM_READ_Q_CHANNEL. |
| CDROM_TOC Device control IRPs with a control code of IOCTL_CDROM_READ_TOC_EX and a format of CDROM_READ_TOC_EX_FORMAT_TOC return their output data in this structure followed by a series of TRACK_DATA structures. |
| CDROM_TOC_ATIP_DATA Device control IRPs with a control code of IOCTL_CDROM_READ_TOC_EX and a format of CDROM_READ_TOC_EX_FORMAT_ATIP return their output data in this header structure followed by a series of descriptors of type CDROM_TOC_ATIP_DATA_BLOCK. |
| CDROM_TOC_ATIP_DATA_BLOCK Device control IRPs with a control code of IOCTL_CDROM_READ_TOC_EX and a format of CDROM_READ_TOC_EX_FORMAT_ATIP return their output data in a header structure of type CDROM_TOC_ATIP_DATA followed by a series of ATIP data block descriptors defined by CDROM_TOC_ATIP_DATA_BLOCK. |
| CDROM_TOC_CD_TEXT_DATA Device control IRPs with a control code of IOCTL_CDROM_READ_TOC_EX and a format of CDROM_READ_TOC_EX_FORMAT_CDTEXT return their output data in this structure followed by a series of descriptors of type CDROM_TOC_CD_TEXT_DATA_BLOCK. |
| CDROM_TOC_CD_TEXT_DATA_BLOCK This structure contains CD text descriptor data used in conjunction with the data in the CDROM_TOC_CD_TEXT_DATA structure. |
| CDROM_TOC_FULL_TOC_DATA Device control IRPs with a control code of IOCTL_CDROM_READ_TOC_EX and a format of CDROM_READ_TOC_EX_FORMAT_FULL_TOC return their output data in this structure optionally followed by a series of descriptors of type CDROM_TOC_FULL_TOC_DATA_BLOCK. |
| CDROM_TOC_FULL_TOC_DATA_BLOCK The CDROM_TOC_FULL_TOC_DATA_BLOCK structure contains track descriptor data used in conjunction with the data from the CDROM_TOC_FULL_TOC_DATA structure. |
| CDROM_TOC_PMA_DATA Device control IRPs with a control code of IOCTL_CDROM_READ_TOC_EX and a format of CDROM_READ_TOC_EX_FORMAT_PMA return their output data in this structure optionally followed by a series of descriptors of type CDROM_TOC_FULL_TOC_DATA_BLOCK. |
| CDROM_TOC_SESSION_DATA Device control IRPs with a control code of IOCTL_CDROM_READ_TOC_EX and a format of CDROM_READ_TOC_EX_FORMAT_SESSION return their output data in this structure followed by a series of TRACK_DATA structures. |
| CDROM_WRITE_SPEED_DESCRIPTOR The CDROM_WRITE_SPEED_DESCRIPTOR structure is returned for the IOCTL_CDROM_GET_PERFORMANCE IOCTL when the request type is CdromWriteSpeedRequest. |
| CDROM_WRITE_SPEED_REQUEST The CDROM_WRITE_SPEED_REQUEST structure is used as an input parameter to the IOCTL_CDROM_GET_PERFORMANCE IOCTL and for requesting write speed descriptors. |
| RAW_READ_INFO The RAW_READ_INFO structure is used in conjunction with the IOCTL_CDROM_RAW_READ request to read data from a CD-ROM in raw mode. |
| SUB_Q_CHANNEL_DATA Device control IRPs with a control code of IOCTL_CDROM_READ_Q_CHANNEL return their output data in this union. |
| SUB_Q_CURRENT_POSITION The SUB_Q_CURRENT_POSITION structure contains position information and is used in conjunction with SUB_Q_CHANNEL_DATA. |
| SUB_Q_HEADER The SUB_Q_HEADER structure contains audio status information and the length of the Q subchannel data being returned. This structure is used in conjunction with SUB_Q_CHANNEL_DATA. |
| SUB_Q_MEDIA_CATALOG_NUMBER The SUB_Q_MEDIA_CATALOG_NUMBER structure contains position information and is used in conjunction with the SUB_Q_CHANNEL_DATA structure. |
| SUB_Q_TRACK_ISRC The SUB_Q_TRACK_ISC contains position information and is used in conjunction with the SUB_Q_CHANNEL_DATA structure. |
| TRACK_DATA Track descriptor is used in conjunction with CDROM_TOC and CDROM_TOC_SESSION_DATA. |
| VOLUME_CONTROL The VOLUME_CONTROL structure is used in conjunction with the IOCTL_CDROM_GET_VOLUME request to retrieve volume values for up to four audio ports. |
Enumerations
| CDROM_OPC_INFO_TYPE The CDROM_OPC_INFO_TYPE enumeration is a member of the CDROM_SIMPLE_OPC_INFO structure. It defines the Optimum Power Calibration (OPC) request that is used as input to the IOCTL_CDROM_SEND_OPC_INFORMATION I/O control request. |
| CDROM_PERFORMANCE_EXCEPTION_TYPE The CDROM_PERFORMANCE_EXCEPTION_TYPE enumeration defines the exceptional conditions for performance data. |
| CDROM_PERFORMANCE_REQUEST_TYPE The CDROM_PERFORMANCE_REQUEST_TYPE enumeration defines the types of performance data requests. It is a member of the CDROM_PERFORMANCE_REQUEST structure, which is used as an input parameter to the IOCTL_CDROM_GET_PERFORMANCE I/O control request. |
| CDROM_PERFORMANCE_TOLERANCE_TYPE The CDROM_PERFORMANCE_TOLERANCE_TYPE enumeration defines the allowable tolerances for performance data. It is a member of the CDROM_PERFORMANCE_REQUEST structure, which is used as an input parameter to the IOCTL_CDROM_GET_PERFORMANCE I/O control request. |
| CDROM_PERFORMANCE_TYPE The CDROM_PERFORMANCE_TYPE enumeration defines the read and write performance data requests. It is a member of the CDROM_PERFORMANCE_REQUEST structure, which is used as an input parameter to the IOCTL_CDROM_GET_PERFORMANCE I/O control request. |
| CDROM_SPEED_REQUEST The CDROM_SPEED_REQUEST enumeration indicates which command that the CD-ROM class driver will use to set the spindle speed of a CD-ROM drive. |
| EXCLUSIVE_ACCESS_REQUEST_TYPE The EXCLUSIVE_ACCESS_REQUEST_TYPE enumeration is used to report the exclusive access state of a CD-ROM device. |
| STREAMING_CONTROL_REQUEST_TYPE The STREAMING_CONTROL_REQUEST_TYPE enumeration defines the CDROM streaming modes. |
| TRACK_MODE_TYPE The TRACK_MODE_TYPE enumeration type is used in conjunction with the IOCTL_CDROM_RAW_READ request and the RAW_READ_INFO structure to read data from a CD-ROM in raw mode. |
| WRITE_ROTATION The WRITE_ROTATION enumeration specifies whether a CD-ROM drive uses constant linear velocity (CLV) rotation or constant angular velocity (CAV) rotation when it writes to a CD. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for