From dbfbf7b888918c86b9336efe3ad0b1d814882d3f Mon Sep 17 00:00:00 2001 From: Tanner Gooding Date: Sun, 24 Dec 2023 12:46:48 -0800 Subject: [PATCH] Add missing xml doc comments --- .../d3d12/D3D12_AUTO_BREADCRUMB_NODE.xml | 2 +- .../d3d12/D3D12_AUTO_BREADCRUMB_NODE1.xml | 19 + .../d3d12/d3d12/D3D12_BARRIER_ACCESS.xml | 32 + .../d3d12/d3d12/D3D12_BARRIER_LAYOUT.xml | 39 + .../d3d12/d3d12/D3D12_BARRIER_SYNC.xml | 29 + .../d3d12/d3d12/D3D12_BARRIER_TYPE.xml | 9 + .../d3d12/d3d12/D3D12_COMMAND_POOL_FLAGS.xml | 7 + .../d3d12/D3D12_COMMAND_RECORDER_FLAGS.xml | 7 + .../D3D12_DEVICE_REMOVED_EXTENDED_DATA2.xml | 9 + .../D3D12_DEVICE_REMOVED_EXTENDED_DATA3.xml | 10 + .../d3d12/D3D12_DISPATCH_MESH_ARGUMENTS.xml | 9 + .../d3d12/D3D12_DRED_ALLOCATION_NODE1.xml | 12 + .../D3D12_DRED_AUTO_BREADCRUMBS_OUTPUT1.xml | 7 + .../d3d12/D3D12_DRED_BREADCRUMB_CONTEXT.xml | 8 + .../d3d12/d3d12/D3D12_DRED_DEVICE_STATE.xml | 10 + .../d3d12/D3D12_DRED_PAGE_FAULT_FLAGS.xml | 7 + .../d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT1.xml | 9 + .../d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT2.xml | 10 + .../D3D12_FEATURE_DATA_D3D12_OPTIONS1.xml | 2 +- .../DirectX/d3d12/d3d12/D3D12_HIT_KIND.xml | 8 + .../D3D12_QUERY_DATA_PIPELINE_STATISTICS1.xml | 20 + .../d3d12/D3D12_TEXTURE_BARRIER_FLAGS.xml | 8 + .../Windows/DirectX/d3d12/d3d12/DirectX.xml | 13 + .../ID3D12DeviceRemovedExtendedData1.xml | 8 + .../ID3D12DeviceRemovedExtendedData2.xml | 8 + ...3D12DeviceRemovedExtendedDataSettings1.xml | 7 + .../d3d12/ID3D12GraphicsCommandList6.xml | 7 + .../DirectX/d3d12/d3d12/ID3D12Heap1.xml | 7 + .../d3d12/d3d12/ID3D12PipelineLibrary1.xml | 8 +- .../d3d12/ID3D12ProtectedResourceSession.xml | 2 +- .../DirectX/d3d12/d3d12/ID3D12Resource1.xml | 7 + .../DirectX/d3d12/d3d12/ID3D12Resource2.xml | 7 + .../d3d12/d3d12/ID3D12SwapChainAssistant.xml | 10 + .../d3d12shader/ID3D12ShaderReflection.xml | 1 + .../D3D12_VIDEO_PROCESS_SUPPORT_FLAGS.xml | 2 +- .../Windows/DirectX/shared/d3d9/DirectX.xml | 31 + .../DirectX/shared/d3d9/IDirect3D9.xml | 177 + .../DirectX/shared/d3d9/IDirect3D9Ex.xml | 69 + .../d3d9/IDirect3D9ExOverlayExtension.xml | 67 + .../d3d9/IDirect3DAuthenticatedChannel9.xml | 43 + .../shared/d3d9/IDirect3DBaseTexture9.xml | 33 + .../shared/d3d9/IDirect3DCryptoSession9.xml | 83 + .../shared/d3d9/IDirect3DCubeTexture9.xml | 57 + .../DirectX/shared/d3d9/IDirect3DDevice9.xml | 914 + .../shared/d3d9/IDirect3DDevice9Ex.xml | 181 + .../shared/d3d9/IDirect3DDevice9Video.xml | 53 + .../shared/d3d9/IDirect3DIndexBuffer9.xml | 43 + .../shared/d3d9/IDirect3DPixelShader9.xml | 19 + .../DirectX/shared/d3d9/IDirect3DQuery9.xml | 33 + .../shared/d3d9/IDirect3DResource9.xml | 72 + .../shared/d3d9/IDirect3DStateBlock9.xml | 21 + .../DirectX/shared/d3d9/IDirect3DSurface9.xml | 64 + .../shared/d3d9/IDirect3DSwapChain9.xml | 65 + .../shared/d3d9/IDirect3DSwapChain9Ex.xml | 19 + .../DirectX/shared/d3d9/IDirect3DTexture9.xml | 53 + .../shared/d3d9/IDirect3DVertexBuffer9.xml | 43 + .../d3d9/IDirect3DVertexDeclaration9.xml | 19 + .../shared/d3d9/IDirect3DVertexShader9.xml | 19 + .../DirectX/shared/d3d9/IDirect3DVolume9.xml | 86 + .../shared/d3d9/IDirect3DVolumeTexture9.xml | 53 + .../DirectX/shared/d3d9caps/D3DCAPS9.xml | 1933 ++ .../d3d9caps/D3DCONTENTPROTECTIONCAPS.xml | 198 + .../shared/d3d9caps/D3DOVERLAYCAPS.xml | 145 + .../shared/d3d9caps/D3DPSHADERCAPS2_0.xml | 23 + .../shared/d3d9caps/D3DVSHADERCAPS2_0.xml | 20 + .../um/DirectML/DML_BUFFER_TENSOR_DESC.xml | 6 +- ...MENT_WISE_BIT_SHIFT_LEFT_OPERATOR_DESC.xml | 2 +- ...ENT_WISE_BIT_SHIFT_RIGHT_OPERATOR_DESC.xml | 2 +- .../DML_ELEMENT_WISE_DIVIDE_OPERATOR_DESC.xml | 2 +- ...ELEMENT_WISE_LOGICAL_AND_OPERATOR_DESC.xml | 2 +- ..._ELEMENT_WISE_LOGICAL_OR_OPERATOR_DESC.xml | 2 +- ...ELEMENT_WISE_LOGICAL_XOR_OPERATOR_DESC.xml | 2 +- .../DML_ELEMENT_WISE_MAX_OPERATOR_DESC.xml | 2 +- .../DML_ELEMENT_WISE_MEAN_OPERATOR_DESC.xml | 2 +- .../DML_ELEMENT_WISE_MIN_OPERATOR_DESC.xml | 2 +- ...EMENT_WISE_MODULUS_FLOOR_OPERATOR_DESC.xml | 2 +- ...NT_WISE_MODULUS_TRUNCATE_OPERATOR_DESC.xml | 2 +- ...ML_ELEMENT_WISE_MULTIPLY_OPERATOR_DESC.xml | 2 +- ...ML_ELEMENT_WISE_SUBTRACT_OPERATOR_DESC.xml | 2 +- .../um/DirectML/DML_GATHER_OPERATOR_DESC.xml | 1 + .../Windows/DirectX/um/Xinput/DirectX.xml | 2 +- .../DirectX/um/Xinput/XINPUT_GAMEPAD.xml | 2 +- .../DirectX/um/Xinput/XINPUT_STATE.xml | 2 +- .../um/d2d1/D2D1_RENDER_TARGET_PROPERTIES.xml | 2 +- .../DirectX/um/d2d1_3/ID2D1Device7.xml | 13 + .../DirectX/um/d2d1_3/ID2D1DeviceContext7.xml | 34 + .../DirectX/um/d2d1_3/ID2D1Factory7.xml | 2 +- .../DirectX/um/d2d1_3/ID2D1Factory8.xml | 16 + .../DirectX/um/d2d1_3/ID2D1SvgGlyphStyle.xml | 4 +- .../d2d1effectauthor/D2D1_PIXEL_OPTIONS.xml | 2 +- .../um/d3d11shader/ID3D11ShaderReflection.xml | 2 +- .../um/dcommon/DWRITE_GLYPH_IMAGE_FORMATS.xml | 30 +- .../DirectX/um/dcomp/IDCompositionDevice.xml | 43 +- .../DirectX/um/dcomp/IDCompositionDevice4.xml | 5 +- .../um/dcomp/IDCompositionFilterEffect.xml | 2 +- .../IDCompositionLinearTransferEffect.xml | 2 +- .../DirectX/um/dcomp/IDCompositionTexture.xml | 14 +- .../um/dwrite/DWRITE_LINE_SPACING_METHOD.xml | 3 +- .../DirectX/um/dwrite/DWRITE_TRIMMING.xml | 5 +- .../DirectX/um/dwrite_2/IDWriteFactory2.xml | 2 +- .../DirectX/um/dwrite_2/IDWriteFont2.xml | 2 +- .../um/dwrite_2/IDWriteFontFallback.xml | 2 +- .../um/dwrite_2/IDWriteTextFormat1.xml | 2 +- .../um/dwrite_2/IDWriteTextLayout2.xml | 2 +- .../um/dwrite_3/IDWriteTextFormat3.xml | 2 +- .../DirectX/um/dxcapi/DxcShaderHash.xml | 2 +- .../DXCoreAdapterMemoryBudget.xml | 4 +- .../um/dxcore_interface/DXCoreHardwareID.xml | 6 +- .../DXCoreNotificationType.xml | 2 +- .../IDXCoreAdapterFactory.xml | 4 +- .../dxcore_interface/IDXCoreAdapterList.xml | 4 +- .../gdipluseffects/RedEyeCorrectionParams.xml | 2 +- .../ISystemMediaTransportControlsInterop.xml | 1 + .../HANDLE_CREATION_OPTIONS.xml | 12 +- .../WinRT.xml | 2 +- .../winrt/CoreWindow/ICoreInputInterop2.xml | 8 + .../CoreWindow/ICoreWindowAdapterInterop.xml | 14 + .../ICoreWindowComponentInterop.xml | 8 + .../Windows/WinRT/winrt/CoreWindow/WinRT.xml | 8 + .../winrt/windows.foundation/DateTime.xml | 12 + .../winrt/windows.foundation/IAsyncAction.xml | 8 + .../winrt/windows.foundation/IClosable.xml | 12 + .../windows.foundation/IPropertyValue.xml | 703 + .../IPropertyValueStatics.xml | 774 + .../winrt/windows.foundation/IStringable.xml | 13 + .../WinRT/winrt/windows.foundation/Point.xml | 16 + .../winrt/windows.foundation/PropertyType.xml | 131 + .../WinRT/winrt/windows.foundation/Rect.xml | 24 + .../WinRT/winrt/windows.foundation/Size.xml | 16 + .../winrt/windows.foundation/TimeSpan.xml | 12 + .../ICompositionTextureInterop.xml | 1 + .../ICompositorInterop2.xml | 5 +- .../Windows/WinRT/winrt/winstring/WinRT.xml | 26 +- .../Windows/shared/mmreg/HEAACWAVEFORMAT.xml | 2 +- .../Windows/shared/mmreg/HEAACWAVEINFO.xml | 2 +- .../Windows/shared/mmreg/MPEG1WAVEFORMAT.xml | 2 +- .../shared/mmreg/MPEGLAYER3WAVEFORMAT.xml | 2 +- .../shared/mmreg/WAVEFORMATEXTENSIBLE.xml | 2 +- .../Windows/shared/strsafe/Windows.xml | 24629 ++++++++++++++++ .../udpmib/MIB_UDP6ROW_OWNER_MODULE.xml | 2 +- .../shared/udpmib/MIB_UDPROW_OWNER_MODULE.xml | 2 +- .../Windows/shared/ws2ipdef/Windows.xml | 144 + .../Windows/shared/wtypes/STATFLAG.xml | 2 +- .../um/AppxPackaging/IAppxBundleFactory2.xml | 2 +- .../um/AppxPackaging/IAppxFactory3.xml | 2 +- .../Windows/Windows/um/CommCtrl/Windows.xml | 11 +- .../Windows/Windows/um/CommDlg/PRINTDLGA.xml | 4 +- .../Windows/um/CommDlg/PRINTDLGEXA.xml | 2 +- .../DISPATCHERQUEUE_THREAD_APARTMENTTYPE.xml | 2 +- .../DISPATCHERQUEUE_THREAD_TYPE.xml | 6 +- .../DispatcherQueueOptions.xml | 6 +- .../Windows/um/DispatcherQueue/Windows.xml | 2 +- .../IIsolatedAppLauncher.xml | 9 +- .../IIsolatedProcessLauncher.xml | 36 + .../IIsolatedProcessLauncher2.xml | 15 + ...IsolatedAppLauncherTelemetryParameters.xml | 14 + .../um/IsolatedAppLauncher/Windows.xml | 16 + .../Windows/um/MDMRegistration/Windows.xml | 2 +- .../Windows/Windows/um/Msi/Windows.xml | 12 +- .../um/ShObjIdl_core/IAppVisibility.xml | 2 +- .../um/ShObjIdl_core/ICommDlgBrowser2.xml | 2 +- .../IShellIconOverlayIdentifier.xml | 2 +- .../Windows/um/ShObjIdl_core/SHCONTF.xml | 2 +- .../Windows/Windows/um/Shlwapi/PARSEDURLA.xml | 4 +- .../Windows/Windows/um/Shlwapi/Windows.xml | 78 +- .../Windows/Windows/um/UserEnv/Windows.xml | 12 +- .../WS_SECURE_CONVERSATION_VERSION.xml | 4 +- .../WS_SECURITY_TOKEN_PROPERTY_ID.xml | 2 +- .../um/WebServices/WS_TRUST_VERSION.xml | 4 +- .../um/WebServices/WS_TYPE_MAPPING.xml | 4 +- .../Windows/um/WebServices/Windows.xml | 6 +- .../WinBase/COPYFILE2_EXTENDED_PARAMETERS.xml | 168 +- .../COPYFILE2_EXTENDED_PARAMETERS_V2.xml | 42 + .../Windows/Windows/um/WinBase/Windows.xml | 12 +- .../Windows/um/WinUser/CBTACTIVATESTRUCT.xml | 2 +- .../Windows/um/WinUser/CBT_CREATEWNDA.xml | 4 +- .../Windows/um/WinUser/CWPRETSTRUCT.xml | 2 +- .../Windows/Windows/um/WinUser/CWPSTRUCT.xml | 6 +- .../Windows/um/WinUser/DEBUGHOOKINFO.xml | 8 +- .../Windows/Windows/um/WinUser/EVENTMSG.xml | 2 +- .../Windows/um/WinUser/MOUSEHOOKSTRUCT.xml | 2 +- .../Windows/um/WinUser/MOUSEHOOKSTRUCTEX.xml | 2 +- .../Windows/Windows/um/WinUser/WNDCLASSA.xml | 4 +- .../Windows/um/WinUser/WNDCLASSEXA.xml | 4 +- .../Windows/Windows/um/WinUser/Windows.xml | 459 +- .../Windows/um/amvideo/AM_FRAMESTEP_STEP.xml | 2 +- .../Windows/um/amvideo/ANALOGVIDEOINFO.xml | 2 +- .../Windows/um/amvideo/IDirectDrawVideo.xml | 34 +- .../Windows/um/amvideo/IFullScreenVideoEx.xml | 44 +- .../Windows/Windows/um/amvideo/IQualProp.xml | 14 +- .../Windows/um/amvideo/MPEG1VIDEOINFO.xml | 2 +- .../Windows/um/amvideo/TRUECOLORINFO.xml | 2 +- .../Windows/Windows/um/amvideo/VIDEOINFO.xml | 2 +- .../Windows/um/amvideo/VIDEOINFOHEADER.xml | 2 +- .../Windows/Windows/um/amvideo/Windows.xml | 24 +- .../um/codecapi/eAVAudioChannelConfig.xml | 2 +- .../Windows/um/codecapi/eAVDDSurroundMode.xml | 2 +- .../codecapi/eAVDSPLoudnessEqualization.xml | 2 +- .../Windows/um/codecapi/eAVDSPSpeakerFill.xml | 2 +- .../um/codecapi/eAVDecAACDownmixMode.xml | 2 +- .../um/codecapi/eAVDecAudioDualMono.xml | 2 +- .../codecapi/eAVDecAudioDualMonoReproMode.xml | 2 +- .../um/codecapi/eAVDecDDOperationalMode.xml | 2 +- .../eAVDecHEAACDynamicRangeControl.xml | 2 +- .../um/codecapi/eAVDecVideoInputScanType.xml | 2 +- .../um/codecapi/eAVDecVideoSWPowerLevel.xml | 2 +- .../eAVDecVideoSoftwareDeinterlaceMode.xml | 2 +- .../um/codecapi/eAVEncAudioDualMono.xml | 2 +- .../um/codecapi/eAVEncAudioInputContent.xml | 2 +- .../codecapi/eAVEncCommonRateControlMode.xml | 2 +- .../eAVEncCommonStreamEndHandling.xml | 2 +- .../um/codecapi/eAVEncDDAtoDConverterType.xml | 2 +- ...eAVEncDDDynamicRangeCompressionControl.xml | 2 +- .../um/codecapi/eAVEncDDHeadphoneMode.xml | 2 +- .../eAVEncDDPreferredStereoDownMixMode.xml | 2 +- .../codecapi/eAVEncDDProductionRoomType.xml | 2 +- .../Windows/um/codecapi/eAVEncDDService.xml | 2 +- .../um/codecapi/eAVEncDDSurroundExMode.xml | 2 +- .../um/codecapi/eAVEncInputVideoSystem.xml | 2 +- .../um/codecapi/eAVEncMPACodingMode.xml | 2 +- .../um/codecapi/eAVEncMPAEmphasisType.xml | 2 +- .../Windows/um/codecapi/eAVEncMPALayer.xml | 2 +- .../um/codecapi/eAVEncMPVFrameFieldMode.xml | 2 +- .../um/codecapi/eAVEncMPVIntraVLCTable.xml | 2 +- .../Windows/um/codecapi/eAVEncMPVLevel.xml | 2 +- .../Windows/um/codecapi/eAVEncMPVProfile.xml | 2 +- .../um/codecapi/eAVEncMPVQScaleType.xml | 2 +- .../um/codecapi/eAVEncMPVScanPattern.xml | 2 +- .../um/codecapi/eAVEncMPVSceneDetection.xml | 2 +- .../Windows/um/codecapi/eAVEncMuxOutput.xml | 2 +- .../codecapi/eAVEncVideoChromaResolution.xml | 2 +- .../codecapi/eAVEncVideoChromaSubsampling.xml | 2 +- .../um/codecapi/eAVEncVideoColorLighting.xml | 2 +- .../codecapi/eAVEncVideoColorNominalRange.xml | 2 +- .../um/codecapi/eAVEncVideoColorPrimaries.xml | 2 +- .../eAVEncVideoColorTransferFunction.xml | 2 +- .../eAVEncVideoColorTransferMatrix.xml | 2 +- .../um/codecapi/eAVEncVideoFilmContent.xml | 2 +- .../eAVEncVideoOutputFrameRateConversion.xml | 2 +- .../um/codecapi/eAVEncVideoOutputScanType.xml | 2 +- .../um/codecapi/eAVEncVideoSourceScanType.xml | 2 +- .../Windows/um/codecapi/eAVFastDecodeMode.xml | 2 +- .../Windows/Windows/um/control/IAMStats.xml | 14 +- .../Windows/um/control/IBasicAudio.xml | 10 +- .../Windows/um/control/IBasicVideo.xml | 66 +- .../Windows/um/control/IBasicVideo2.xml | 4 +- .../Windows/um/control/IDeferredCommand.xml | 10 +- .../Windows/um/control/IMediaControl.xml | 20 +- .../Windows/um/control/IMediaEvent.xml | 14 +- .../Windows/um/control/IMediaEventEx.xml | 12 +- .../Windows/um/control/IMediaPosition.xml | 24 +- .../Windows/um/control/IQueueCommand.xml | 6 +- .../Windows/um/control/IVideoWindow.xml | 80 +- .../um/ctfutb/ITfSystemLangBarItem.xml | 2 +- .../um/devicetopology/IAudioChannelConfig.xml | 12 +- .../Windows/Windows/um/dvdmedia/AM_COLCON.xml | 2 +- .../um/dvdmedia/AM_COPY_MACROVISION.xml | 2 +- .../um/dvdmedia/AM_COPY_MACROVISION_LEVEL.xml | 2 +- .../Windows/um/dvdmedia/AM_DVDCOPYSTATE.xml | 2 +- .../Windows/um/dvdmedia/AM_DVDCOPY_BUSKEY.xml | 2 +- .../um/dvdmedia/AM_DVDCOPY_CHLGKEY.xml | 2 +- .../um/dvdmedia/AM_DVDCOPY_DISCKEY.xml | 2 +- .../um/dvdmedia/AM_DVDCOPY_SET_COPY_STATE.xml | 2 +- .../um/dvdmedia/AM_DVDCOPY_TITLEKEY.xml | 2 +- .../Windows/um/dvdmedia/AM_DVD_YUV.xml | 2 +- .../Windows/um/dvdmedia/AM_DvdKaraokeData.xml | 2 +- .../um/dvdmedia/AM_ExactRateChange.xml | 2 +- .../Windows/um/dvdmedia/AM_MPEG2Level.xml | 2 +- .../Windows/um/dvdmedia/AM_MPEG2Profile.xml | 2 +- .../dvdmedia/AM_PROPERTY_DVD_RATE_CHANGE.xml | 2 +- .../Windows/um/dvdmedia/AM_PROPERTY_SPHLI.xml | 2 +- .../Windows/um/dvdmedia/AM_PROPERTY_SPPAL.xml | 2 +- .../Windows/um/dvdmedia/AM_QueryRate.xml | 2 +- .../um/dvdmedia/AM_SimpleRateChange.xml | 2 +- .../Windows/um/dvdmedia/DVD_REGION.xml | 2 +- .../Windows/um/dvdmedia/MPEG2VIDEOINFO.xml | 2 +- .../Windows/um/dvdmedia/VIDEOINFOHEADER2.xml | 2 +- .../Windows/um/dwmapi/DWMWINDOWATTRIBUTE.xml | 10 +- .../um/dwmapi/DWM_SYSTEMBACKDROP_TYPE.xml | 20 +- .../Windows/Windows/um/dwmapi/Windows.xml | 2 +- .../Windows/Windows/um/fileapi/Windows.xml | 32 +- .../Windows/Windows/um/heapapi/Windows.xml | 68 + .../Windows/um/imapi2fs/IIsoImageManager.xml | 7 + .../Windows/Windows/um/ioapiset/Windows.xml | 5 - .../Windows/Windows/um/iphlpapi/Windows.xml | 2 +- .../Windows/um/libloaderapi/Windows.xml | 11 + .../Windows/um/mediaobj/DMO_MEDIA_TYPE.xml | 2 +- .../um/mediaobj/DMO_OUTPUT_DATA_BUFFER.xml | 2 +- .../um/mediaobj/IDMOQualityControl.xml | 8 +- .../mediaobj/IDMOVideoOutputOptimizations.xml | 10 +- .../Windows/Windows/um/mediaobj/IEnumDMO.xml | 10 +- .../Windows/um/mediaobj/IMediaBuffer.xml | 8 +- .../Windows/um/mediaobj/IMediaObject.xml | 44 +- .../um/mediaobj/IMediaObjectInPlace.xml | 8 +- .../mediaobj/_DMO_INPUT_DATA_BUFFER_FLAGS.xml | 2 +- .../mediaobj/_DMO_INPUT_STREAM_INFO_FLAGS.xml | 2 +- .../_DMO_OUTPUT_DATA_BUFFER_FLAGS.xml | 2 +- .../_DMO_OUTPUT_STREAM_INFO_FLAGS.xml | 2 +- .../um/mediaobj/_DMO_PROCESS_OUTPUT_FLAGS.xml | 2 +- .../um/mediaobj/_DMO_SET_TYPE_FLAGS.xml | 2 +- .../_DMO_VIDEO_OUTPUT_STREAM_FLAGS.xml | 2 +- .../Windows/Windows/um/memoryapi/Windows.xml | 34 +- .../Windows/Windows/um/mfapi/Windows.xml | 2 +- .../Windows/um/mfidl/IMFTranscodeProfile.xml | 2 +- .../mfidl/IMFVideoCaptureSampleAllocator.xml | 2 +- .../mfmediaengine/IMFMediaEngineExtension.xml | 2 +- .../Windows/Windows/um/objidl/IDataObject.xml | 2 +- .../Windows/um/processthreadsapi/Windows.xml | 14 +- .../projectedfslib/PRJ_PLACEHOLDER_INFO.xml | 2 +- .../Windows/um/projectedfslib/Windows.xml | 2 +- .../um/shdeprecated/IExpDispSupport.xml | 14 + .../um/strmif/ALLOCATOR_PROPERTIES.xml | 2 +- .../Windows/um/strmif/AMCOPPCommand.xml | 2 +- .../Windows/um/strmif/AMCOPPSignature.xml | 2 +- .../Windows/um/strmif/AMCOPPStatusInput.xml | 2 +- .../Windows/um/strmif/AMCOPPStatusOutput.xml | 2 +- .../Windows/Windows/um/strmif/AMOVERLAYFX.xml | 2 +- .../Windows/um/strmif/AMTunerModeType.xml | 2 +- .../Windows/um/strmif/AM_DVD_GRAPH_FLAGS.xml | 2 +- .../Windows/um/strmif/AM_DVD_RENDERSTATUS.xml | 2 +- .../Windows/um/strmif/AM_DVD_STREAM_FLAGS.xml | 2 +- .../AM_GRAPH_CONFIG_RECONNECT_FLAGS.xml | 2 +- .../Windows/um/strmif/AM_MEDIA_TYPE.xml | 2 +- .../um/strmif/AM_SAMPLE2_PROPERTIES.xml | 2 +- .../AM_SEEKING_SEEKING_CAPABILITIES.xml | 2 +- .../Windows/um/strmif/AM_STREAM_INFO.xml | 2 +- .../um/strmif/AM_STREAM_INFO_FLAGS.xml | 2 +- .../um/strmif/AUDIO_STREAM_CONFIG_CAPS.xml | 2 +- .../Windows/um/strmif/AnalogVideoStandard.xml | 2 +- .../Windows/Windows/um/strmif/COLORKEY.xml | 2 +- .../Windows/um/strmif/CameraControlFlags.xml | 2 +- .../um/strmif/CameraControlProperty.xml | 2 +- .../Windows/um/strmif/CodecAPIEventData.xml | 2 +- .../Windows/um/strmif/CompressionCaps.xml | 2 +- .../Windows/Windows/um/strmif/DDCOLORKEY.xml | 2 +- .../Windows/um/strmif/DECIMATION_USAGE.xml | 2 +- .../Windows/um/strmif/DVD_AUDIO_APPMODE.xml | 2 +- .../Windows/um/strmif/DVD_AUDIO_FORMAT.xml | 2 +- .../Windows/um/strmif/DVD_AUDIO_LANG_EXT.xml | 2 +- .../Windows/um/strmif/DVD_AudioAttributes.xml | 2 +- .../Windows/um/strmif/DVD_CMD_FLAGS.xml | 2 +- .../Windows/um/strmif/DVD_DECODER_CAPS.xml | 2 +- .../Windows/um/strmif/DVD_DISC_SIDE.xml | 2 +- .../Windows/Windows/um/strmif/DVD_DOMAIN.xml | 2 +- .../Windows/um/strmif/DVD_FRAMERATE.xml | 2 +- .../Windows/um/strmif/DVD_HMSF_TIMECODE.xml | 2 +- .../um/strmif/DVD_KARAOKE_ASSIGNMENT.xml | 2 +- .../um/strmif/DVD_KARAOKE_CONTENTS.xml | 2 +- .../Windows/um/strmif/DVD_KARAOKE_DOWNMIX.xml | 2 +- .../um/strmif/DVD_KaraokeAttributes.xml | 2 +- .../Windows/Windows/um/strmif/DVD_MENU_ID.xml | 2 +- .../Windows/um/strmif/DVD_MUA_Coeff.xml | 2 +- .../Windows/um/strmif/DVD_MUA_MixingInfo.xml | 2 +- .../Windows/um/strmif/DVD_MenuAttributes.xml | 2 +- .../DVD_MultichannelAudioAttributes.xml | 2 +- .../Windows/um/strmif/DVD_NavCmdType.xml | 2 +- .../Windows/um/strmif/DVD_PARENTAL_LEVEL.xml | 2 +- .../um/strmif/DVD_PLAYBACK_LOCATION.xml | 2 +- .../um/strmif/DVD_PLAYBACK_LOCATION2.xml | 2 +- .../um/strmif/DVD_PREFERRED_DISPLAY_MODE.xml | 2 +- .../Windows/um/strmif/DVD_RELATIVE_BUTTON.xml | 2 +- .../um/strmif/DVD_SUBPICTURE_CODING.xml | 2 +- .../um/strmif/DVD_SUBPICTURE_LANG_EXT.xml | 2 +- .../Windows/um/strmif/DVD_SUBPICTURE_TYPE.xml | 2 +- .../um/strmif/DVD_SubpictureAttributes.xml | 2 +- .../Windows/um/strmif/DVD_TIMECODE.xml | 2 +- .../Windows/um/strmif/DVD_TIMECODE_FLAGS.xml | 2 +- .../Windows/um/strmif/DVD_TITLE_APPMODE.xml | 2 +- .../Windows/um/strmif/DVD_TextCharSet.xml | 2 +- .../Windows/um/strmif/DVD_TextStringType.xml | 2 +- .../Windows/um/strmif/DVD_TitleAttributes.xml | 2 +- .../um/strmif/DVD_VIDEO_COMPRESSION.xml | 2 +- .../Windows/um/strmif/DVD_VideoAttributes.xml | 2 +- .../Windows/Windows/um/strmif/DVINFO.xml | 2 +- .../Windows/Windows/um/strmif/FILTER_INFO.xml | 2 +- .../Windows/um/strmif/FILTER_STATE.xml | 2 +- .../um/strmif/IAMAnalogVideoDecoder.xml | 20 +- .../um/strmif/IAMAnalogVideoEncoder.xml | 18 +- .../strmif/IAMAsyncReaderTimestampScaling.xml | 6 +- .../Windows/um/strmif/IAMAudioInputMixer.xml | 36 +- .../um/strmif/IAMAudioRendererStats.xml | 4 +- .../um/strmif/IAMBufferNegotiation.xml | 6 +- .../Windows/um/strmif/IAMCameraControl.xml | 8 +- .../strmif/IAMCertifiedOutputProtection.xml | 10 +- .../Windows/um/strmif/IAMClockAdjust.xml | 4 +- .../Windows/um/strmif/IAMClockSlave.xml | 6 +- .../um/strmif/IAMCopyCaptureFileProgress.xml | 4 +- .../Windows/Windows/um/strmif/IAMCrossbar.xml | 12 +- .../Windows/um/strmif/IAMDecoderCaps.xml | 4 +- .../um/strmif/IAMDevMemoryAllocator.xml | 12 +- .../Windows/um/strmif/IAMDevMemoryControl.xml | 8 +- .../Windows/um/strmif/IAMDeviceRemoval.xml | 8 +- .../Windows/um/strmif/IAMDroppedFrames.xml | 10 +- .../Windows/um/strmif/IAMExtDevice.xml | 18 +- .../Windows/um/strmif/IAMExtTransport.xml | 56 +- .../um/strmif/IAMFilterGraphCallback.xml | 4 +- .../Windows/um/strmif/IAMFilterMiscFlags.xml | 4 +- .../um/strmif/IAMGraphBuilderCallback.xml | 6 +- .../Windows/um/strmif/IAMGraphStreams.xml | 8 +- .../Windows/Windows/um/strmif/IAMLatency.xml | 4 +- .../Windows/um/strmif/IAMOpenProgress.xml | 6 +- .../Windows/um/strmif/IAMOverlayFX.xml | 8 +- .../Windows/um/strmif/IAMPhysicalPinInfo.xml | 4 +- .../Windows/um/strmif/IAMPluginControl.xml | 16 +- .../Windows/um/strmif/IAMPushSource.xml | 14 +- .../Windows/um/strmif/IAMResourceControl.xml | 4 +- .../Windows/um/strmif/IAMStreamConfig.xml | 8 +- .../Windows/um/strmif/IAMStreamControl.xml | 8 +- .../Windows/um/strmif/IAMStreamSelect.xml | 8 +- .../Windows/Windows/um/strmif/IAMTVAudio.xml | 14 +- .../um/strmif/IAMTVAudioNotification.xml | 4 +- .../Windows/Windows/um/strmif/IAMTVTuner.xml | 26 +- .../Windows/um/strmif/IAMTimecodeDisplay.xml | 10 +- .../um/strmif/IAMTimecodeGenerator.xml | 14 +- .../Windows/um/strmif/IAMTimecodeReader.xml | 12 +- .../Windows/Windows/um/strmif/IAMTuner.xml | 32 +- .../um/strmif/IAMTunerNotification.xml | 4 +- .../um/strmif/IAMVfwCaptureDialogs.xml | 8 +- .../um/strmif/IAMVfwCompressDialogs.xml | 10 +- .../Windows/um/strmif/IAMVideoCompression.xml | 24 +- .../Windows/um/strmif/IAMVideoControl.xml | 14 +- .../strmif/IAMVideoDecimationProperties.xml | 6 +- .../Windows/um/strmif/IAMVideoProcAmp.xml | 8 +- .../Windows/um/strmif/IAMovieSetup.xml | 6 +- .../Windows/um/strmif/IAsyncReader.xml | 18 +- .../Windows/um/strmif/IBPCSatelliteTuner.xml | 8 +- .../Windows/Windows/um/strmif/IBaseFilter.xml | 16 +- .../um/strmif/ICaptureGraphBuilder.xml | 18 +- .../um/strmif/ICaptureGraphBuilder2.xml | 18 +- .../Windows/Windows/um/strmif/ICodecAPI.xml | 32 +- .../Windows/um/strmif/IConfigAviMux.xml | 10 +- .../Windows/um/strmif/IConfigInterleaving.xml | 10 +- .../Windows/um/strmif/ICreateDevEnum.xml | 4 +- .../Windows/um/strmif/IDDrawExclModeVideo.xml | 16 +- .../um/strmif/IDDrawExclModeVideoCallback.xml | 8 +- .../Windows/Windows/um/strmif/IDVEnc.xml | 6 +- .../Windows/Windows/um/strmif/IDVRGB219.xml | 4 +- .../Windows/Windows/um/strmif/IDVSplitter.xml | 4 +- .../Windows/um/strmif/IDecimateVideoImage.xml | 6 +- .../Windows/um/strmif/IDistributorNotify.xml | 12 +- .../Windows/um/strmif/IDrawVideoImage.xml | 8 +- .../Windows/Windows/um/strmif/IDvdCmd.xml | 6 +- .../Windows/Windows/um/strmif/IDvdControl.xml | 72 +- .../Windows/um/strmif/IDvdControl2.xml | 78 +- .../Windows/um/strmif/IDvdGraphBuilder.xml | 8 +- .../Windows/Windows/um/strmif/IDvdInfo.xml | 48 +- .../Windows/Windows/um/strmif/IDvdInfo2.xml | 80 +- .../Windows/Windows/um/strmif/IDvdState.xml | 6 +- .../Windows/um/strmif/IEnumFilters.xml | 10 +- .../Windows/um/strmif/IEnumMediaTypes.xml | 10 +- .../Windows/Windows/um/strmif/IEnumPins.xml | 10 +- .../Windows/um/strmif/IEnumRegFilters.xml | 10 +- .../Windows/um/strmif/IEnumStreamIdMap.xml | 10 +- .../Windows/um/strmif/IFileSinkFilter.xml | 6 +- .../Windows/um/strmif/IFileSinkFilter2.xml | 8 +- .../Windows/um/strmif/IFileSourceFilter.xml | 6 +- .../Windows/um/strmif/IFilterChain.xml | 10 +- .../Windows/um/strmif/IFilterGraph.xml | 18 +- .../Windows/um/strmif/IFilterGraph2.xml | 6 +- .../Windows/um/strmif/IFilterGraph3.xml | 4 +- .../Windows/um/strmif/IFilterMapper.xml | 18 +- .../Windows/um/strmif/IFilterMapper2.xml | 8 +- .../Windows/um/strmif/IFilterMapper3.xml | 4 +- .../Windows/um/strmif/IGetCapabilitiesKey.xml | 4 +- .../Windows/um/strmif/IGraphBuilder.xml | 20 +- .../Windows/um/strmif/IGraphConfig.xml | 22 +- .../um/strmif/IGraphConfigCallback.xml | 4 +- .../Windows/um/strmif/IGraphVersion.xml | 4 +- .../Windows/Windows/um/strmif/IIPDVDec.xml | 6 +- .../Windows/um/strmif/IMPEG2StreamIdMap.xml | 8 +- .../Windows/um/strmif/IMediaEventSink.xml | 4 +- .../Windows/um/strmif/IMediaFilter.xml | 14 +- .../Windows/um/strmif/IMediaPropertyBag.xml | 4 +- .../Windows/um/strmif/IMediaSample.xml | 34 +- .../Windows/um/strmif/IMediaSample2.xml | 6 +- .../Windows/um/strmif/IMediaSample2Config.xml | 4 +- .../Windows/um/strmif/IMediaSeeking.xml | 32 +- .../Windows/um/strmif/IMemAllocator.xml | 14 +- .../um/strmif/IMemAllocatorCallbackTemp.xml | 6 +- .../IMemAllocatorNotifyCallbackTemp.xml | 2 +- .../Windows/um/strmif/IMemInputPin.xml | 14 +- .../Windows/um/strmif/IMpeg2Demultiplexer.xml | 8 +- .../Windows/Windows/um/strmif/IOverlay.xml | 24 +- .../Windows/um/strmif/IOverlayNotify.xml | 10 +- .../Windows/um/strmif/IOverlayNotify2.xml | 4 +- .../um/strmif/IPersistMediaPropertyBag.xml | 6 +- .../Windows/Windows/um/strmif/IPin.xml | 32 +- .../Windows/um/strmif/IPinConnection.xml | 10 +- .../Windows/um/strmif/IPinFlowControl.xml | 4 +- .../Windows/um/strmif/IQualityControl.xml | 6 +- .../Windows/um/strmif/IReferenceClock.xml | 8 +- .../um/strmif/IReferenceClockTimerControl.xml | 6 +- .../um/strmif/IRegisterServiceProvider.xml | 4 +- .../Windows/um/strmif/IResourceConsumer.xml | 6 +- .../Windows/um/strmif/IResourceManager.xml | 18 +- .../Windows/um/strmif/ISeekingPassThru.xml | 4 +- .../Windows/um/strmif/IStreamBuilder.xml | 6 +- .../um/strmif/IVMRAspectRatioControl.xml | 6 +- .../um/strmif/IVMRDeinterlaceControl.xml | 16 +- .../Windows/um/strmif/IVMRFilterConfig.xml | 16 +- .../Windows/um/strmif/IVMRImageCompositor.xml | 12 +- .../Windows/um/strmif/IVMRImagePresenter.xml | 8 +- .../um/strmif/IVMRImagePresenterConfig.xml | 6 +- .../IVMRImagePresenterExclModeConfig.xml | 6 +- .../Windows/um/strmif/IVMRMixerBitmap.xml | 6 +- .../Windows/um/strmif/IVMRMixerControl.xml | 20 +- .../Windows/um/strmif/IVMRMonitorConfig.xml | 12 +- .../Windows/Windows/um/strmif/IVMRSurface.xml | 10 +- .../um/strmif/IVMRSurfaceAllocator.xml | 10 +- .../um/strmif/IVMRSurfaceAllocatorNotify.xml | 14 +- .../um/strmif/IVMRVideoStreamControl.xml | 10 +- .../um/strmif/IVMRWindowlessControl.xml | 32 +- .../Windows/Windows/um/strmif/IVPManager.xml | 6 +- .../Windows/um/strmif/IVideoFrameStep.xml | 8 +- .../Windows/um/strmif/InterleavingMode.xml | 2 +- .../Windows/um/strmif/NORMALIZEDRECT.xml | 2 +- .../Windows/um/strmif/PIN_DIRECTION.xml | 2 +- .../Windows/Windows/um/strmif/PIN_INFO.xml | 2 +- .../um/strmif/PhysicalConnectorType.xml | 2 +- .../Windows/Windows/um/strmif/Quality.xml | 2 +- .../Windows/um/strmif/QualityMessageType.xml | 2 +- .../Windows/Windows/um/strmif/REGFILTER2.xml | 2 +- .../Windows/um/strmif/REGFILTERPINS.xml | 2 +- .../Windows/um/strmif/REGFILTERPINS2.xml | 2 +- .../Windows/um/strmif/REGPINMEDIUM.xml | 2 +- .../Windows/Windows/um/strmif/REGPINTYPES.xml | 2 +- .../Windows/um/strmif/STREAM_ID_MAP.xml | 2 +- .../Windows/Windows/um/strmif/TIMECODE.xml | 2 +- .../Windows/um/strmif/TIMECODE_SAMPLE.xml | 2 +- .../Windows/um/strmif/TunerInputType.xml | 2 +- .../Windows/um/strmif/VALID_UOP_FLAG.xml | 2 +- .../um/strmif/VIDEOENCODER_BITRATE_MODE.xml | 2 +- .../um/strmif/VIDEO_STREAM_CONFIG_CAPS.xml | 2 +- .../Windows/um/strmif/VMRALLOCATIONINFO.xml | 2 +- .../Windows/um/strmif/VMRALPHABITMAP.xml | 2 +- .../Windows/um/strmif/VMRDeinterlaceCaps.xml | 2 +- .../Windows/um/strmif/VMRDeinterlacePrefs.xml | 2 +- .../Windows/um/strmif/VMRDeinterlaceTech.xml | 2 +- .../Windows/um/strmif/VMRFrequency.xml | 2 +- .../Windows/Windows/um/strmif/VMRGUID.xml | 2 +- .../Windows/um/strmif/VMRMONITORINFO.xml | 2 +- .../Windows/um/strmif/VMRMixerPrefs.xml | 2 +- .../Windows/Windows/um/strmif/VMRMode.xml | 2 +- .../Windows/um/strmif/VMRPRESENTATIONINFO.xml | 2 +- .../um/strmif/VMRPresentationFlags.xml | 2 +- .../Windows/um/strmif/VMRRenderPrefs.xml | 2 +- .../um/strmif/VMRSurfaceAllocationFlags.xml | 2 +- .../Windows/um/strmif/VMRVIDEOSTREAMINFO.xml | 2 +- .../Windows/um/strmif/VMRVideoDesc.xml | 2 +- .../um/strmif/VMR_ASPECT_RATIO_MODE.xml | 2 +- .../Windows/um/strmif/VfwCaptureDialogs.xml | 2 +- .../Windows/um/strmif/VfwCompressDialogs.xml | 2 +- .../Windows/um/strmif/VideoControlFlags.xml | 2 +- .../Windows/um/strmif/VideoProcAmpFlags.xml | 2 +- .../um/strmif/VideoProcAmpProperty.xml | 2 +- .../um/strmif/_AMRESCTL_RESERVEFLAGS.xml | 2 +- .../strmif/_AM_AUDIO_RENDERER_STAT_PARAM.xml | 2 +- .../um/strmif/_AM_FILTER_MISC_FLAGS.xml | 2 +- .../um/strmif/_AM_INTF_SEARCH_FLAGS.xml | 2 +- .../um/strmif/_AM_OVERLAY_NOTIFY_FLAGS.xml | 2 +- .../_AM_PIN_FLOW_CONTROL_BLOCK_FLAGS.xml | 2 +- .../um/strmif/_AM_PUSHSOURCE_FLAGS.xml | 2 +- .../Windows/um/strmif/_DVENCODERFORMAT.xml | 2 +- .../um/strmif/_DVENCODERRESOLUTION.xml | 2 +- .../um/strmif/_DVENCODERVIDEOFORMAT.xml | 2 +- .../Windows/um/strmif/_DVRESOLUTION.xml | 2 +- .../Windows/um/strmif/_REM_FILTER_FLAGS.xml | 2 +- .../um/strmif/tagAM_SAMPLE_PROPERTY_FLAGS.xml | 2 +- .../DEVELOPER_DRIVE_ENABLEMENT_STATE.xml | 20 + .../Windows/Windows/um/sysinfoapi/Windows.xml | 16 +- .../Windows/um/wincodec/WICDdsAlphaMode.xml | 2 +- .../wincrypt/CRYPT_ALGORITHM_IDENTIFIER.xml | 3 +- .../Windows/Windows/um/wincrypt/Windows.xml | 39 +- .../Windows/um/wingdi/BITMAPFILEHEADER.xml | 2 +- .../Windows/um/wingdi/BITMAPINFOHEADER.xml | 2 +- .../Windows/Windows/um/wingdi/DEVMODEW.xml | 18 +- .../Windows/Windows/um/wingdi/LOGPEN.xml | 2 +- .../Windows/Windows/um/winhttp/Windows.xml | 2 +- .../winioctl/REQUEST_OPLOCK_OUTPUT_BUFFER.xml | 2 +- .../Windows/um/winioctl/USN_RECORD_V3.xml | 2 +- .../Interop/Windows/Windows/um/winnt/ACL.xml | 2 +- .../um/winnt/MEM_ADDRESS_REQUIREMENTS.xml | 4 +- .../um/winnt/MEM_EXTENDED_PARAMETER.xml | 11 +- .../um/winnt/MEM_EXTENDED_PARAMETER_TYPE.xml | 4 +- ..._MITIGATION_SYSTEM_CALL_DISABLE_POLICY.xml | 53 +- .../um/winnt/TOKEN_INFORMATION_CLASS.xml | 7 +- .../Windows/Windows/um/winreg/Windows.xml | 12 +- 587 files changed, 33867 insertions(+), 2012 deletions(-) create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_AUTO_BREADCRUMB_NODE1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_ACCESS.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_LAYOUT.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_SYNC.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_TYPE.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_COMMAND_POOL_FLAGS.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_COMMAND_RECORDER_FLAGS.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DEVICE_REMOVED_EXTENDED_DATA2.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DEVICE_REMOVED_EXTENDED_DATA3.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DISPATCH_MESH_ARGUMENTS.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_ALLOCATION_NODE1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_AUTO_BREADCRUMBS_OUTPUT1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_BREADCRUMB_CONTEXT.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_DEVICE_STATE.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_FLAGS.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT2.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_HIT_KIND.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_QUERY_DATA_PIPELINE_STATISTICS1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_TEXTURE_BARRIER_FLAGS.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedData1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedData2.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedDataSettings1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12GraphicsCommandList6.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Heap1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Resource1.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Resource2.xml create mode 100644 sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12SwapChainAssistant.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/DirectX.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9Ex.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9ExOverlayExtension.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DAuthenticatedChannel9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DBaseTexture9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DCryptoSession9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DCubeTexture9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9Ex.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9Video.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DIndexBuffer9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DPixelShader9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DQuery9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DResource9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DStateBlock9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSurface9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSwapChain9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSwapChain9Ex.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DTexture9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexBuffer9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexDeclaration9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexShader9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVolume9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVolumeTexture9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9caps/D3DCAPS9.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9caps/D3DCONTENTPROTECTIONCAPS.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9caps/D3DOVERLAYCAPS.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9caps/D3DPSHADERCAPS2_0.xml create mode 100644 sources/Interop/Windows/DirectX/shared/d3d9caps/D3DVSHADERCAPS2_0.xml create mode 100644 sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Device7.xml create mode 100644 sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1DeviceContext7.xml create mode 100644 sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Factory8.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreInputInterop2.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreWindowAdapterInterop.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreWindowComponentInterop.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/DateTime.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/IAsyncAction.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/IClosable.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/IPropertyValue.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/IPropertyValueStatics.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/IStringable.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/Point.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/PropertyType.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/Rect.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/Size.xml create mode 100644 sources/Interop/Windows/WinRT/winrt/windows.foundation/TimeSpan.xml create mode 100644 sources/Interop/Windows/Windows/shared/strsafe/Windows.xml create mode 100644 sources/Interop/Windows/Windows/shared/ws2ipdef/Windows.xml create mode 100644 sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedProcessLauncher.xml create mode 100644 sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedProcessLauncher2.xml create mode 100644 sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IsolatedAppLauncherTelemetryParameters.xml create mode 100644 sources/Interop/Windows/Windows/um/IsolatedAppLauncher/Windows.xml create mode 100644 sources/Interop/Windows/Windows/um/WinBase/COPYFILE2_EXTENDED_PARAMETERS_V2.xml create mode 100644 sources/Interop/Windows/Windows/um/sysinfoapi/DEVELOPER_DRIVE_ENABLEMENT_STATE.xml diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_AUTO_BREADCRUMB_NODE.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_AUTO_BREADCRUMB_NODE.xml index 591dbfec30..c9297d1e64 100644 --- a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_AUTO_BREADCRUMB_NODE.xml +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_AUTO_BREADCRUMB_NODE.xml @@ -30,7 +30,7 @@ A UINT32 containing the count of values in the array pointed to by pCommandHistory. - A pointer to a constant UINT32 containing the index (within the array pointed to by pCommandHistory) of the last render/compute operation that was completed by the GPU while executing the associated command list. + A pointer to a constant UINT32 containing the number of pCommandHistory breadcrumbs ops completed. As such, the last successfully completed breadcrumb op is at index (*pLastBreadcrumbValue - 1) in pCommandHistory. A pointer to a constant array of values representing all of the render/compute operations recorded into the associated command list. diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_AUTO_BREADCRUMB_NODE1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_AUTO_BREADCRUMB_NODE1.xml new file mode 100644 index 0000000000..b16fa65101 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_AUTO_BREADCRUMB_NODE1.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_ACCESS.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_ACCESS.xml new file mode 100644 index 0000000000..ce65593241 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_ACCESS.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_LAYOUT.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_LAYOUT.xml new file mode 100644 index 0000000000..c930b29d78 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_LAYOUT.xml @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_SYNC.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_SYNC.xml new file mode 100644 index 0000000000..6edae698b6 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_SYNC.xml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_TYPE.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_TYPE.xml new file mode 100644 index 0000000000..c77aee68bd --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_BARRIER_TYPE.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_COMMAND_POOL_FLAGS.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_COMMAND_POOL_FLAGS.xml new file mode 100644 index 0000000000..f563fe41a1 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_COMMAND_POOL_FLAGS.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_COMMAND_RECORDER_FLAGS.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_COMMAND_RECORDER_FLAGS.xml new file mode 100644 index 0000000000..8bbd495565 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_COMMAND_RECORDER_FLAGS.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DEVICE_REMOVED_EXTENDED_DATA2.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DEVICE_REMOVED_EXTENDED_DATA2.xml new file mode 100644 index 0000000000..17024cb554 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DEVICE_REMOVED_EXTENDED_DATA2.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DEVICE_REMOVED_EXTENDED_DATA3.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DEVICE_REMOVED_EXTENDED_DATA3.xml new file mode 100644 index 0000000000..d4c72987d9 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DEVICE_REMOVED_EXTENDED_DATA3.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DISPATCH_MESH_ARGUMENTS.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DISPATCH_MESH_ARGUMENTS.xml new file mode 100644 index 0000000000..a6339be902 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DISPATCH_MESH_ARGUMENTS.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_ALLOCATION_NODE1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_ALLOCATION_NODE1.xml new file mode 100644 index 0000000000..c4623bb19c --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_ALLOCATION_NODE1.xml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_AUTO_BREADCRUMBS_OUTPUT1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_AUTO_BREADCRUMBS_OUTPUT1.xml new file mode 100644 index 0000000000..68aa44890d --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_AUTO_BREADCRUMBS_OUTPUT1.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_BREADCRUMB_CONTEXT.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_BREADCRUMB_CONTEXT.xml new file mode 100644 index 0000000000..f5135db701 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_BREADCRUMB_CONTEXT.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_DEVICE_STATE.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_DEVICE_STATE.xml new file mode 100644 index 0000000000..a9d9a2a696 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_DEVICE_STATE.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_FLAGS.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_FLAGS.xml new file mode 100644 index 0000000000..e4c3772267 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_FLAGS.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT1.xml new file mode 100644 index 0000000000..5ce7c57140 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT1.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT2.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT2.xml new file mode 100644 index 0000000000..de72ee5c35 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_DRED_PAGE_FAULT_OUTPUT2.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_FEATURE_DATA_D3D12_OPTIONS1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_FEATURE_DATA_D3D12_OPTIONS1.xml index 2621b491cc..7e24e5b7b5 100644 --- a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_FEATURE_DATA_D3D12_OPTIONS1.xml +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_FEATURE_DATA_D3D12_OPTIONS1.xml @@ -12,7 +12,7 @@ Specifies the baseline number of lanes in the SIMD wave that this implementation can support. This term is sometimes known as "wavefront size" or "warp width". Currently apps should rely only on this minimum value for sizing workloads. - Specifies the maximum number of lanes in the SIMD wave that this implementation can support. This capability is reserved for future expansion, and is not expected to be used by current applications. + Specifies the maximum number of lanes in the SIMD wave that this implementation can support. Specifies the total number of SIMD lanes on the hardware. diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_HIT_KIND.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_HIT_KIND.xml new file mode 100644 index 0000000000..826b3298d7 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_HIT_KIND.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_QUERY_DATA_PIPELINE_STATISTICS1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_QUERY_DATA_PIPELINE_STATISTICS1.xml new file mode 100644 index 0000000000..15d35f0965 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_QUERY_DATA_PIPELINE_STATISTICS1.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_TEXTURE_BARRIER_FLAGS.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_TEXTURE_BARRIER_FLAGS.xml new file mode 100644 index 0000000000..01f84ddf8e --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/D3D12_TEXTURE_BARRIER_FLAGS.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/DirectX.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/DirectX.xml index de31e08e18..f034da4228 100644 --- a/sources/Interop/Windows/DirectX/d3d12/d3d12/DirectX.xml +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/DirectX.xml @@ -105,4 +105,17 @@ A pointer to a memory block that receives a pointer to the ID3DBlob interface that you can use to access serializer error messages, or NULL if there are no errors. Returns S_OK if successful; otherwise, returns one of the Direct3D 12 Return Codes. + + + + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedData1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedData1.xml new file mode 100644 index 0000000000..50e8883309 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedData1.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedData2.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedData2.xml new file mode 100644 index 0000000000..83545078ac --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedData2.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedDataSettings1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedDataSettings1.xml new file mode 100644 index 0000000000..1fce9595ed --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12DeviceRemovedExtendedDataSettings1.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12GraphicsCommandList6.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12GraphicsCommandList6.xml new file mode 100644 index 0000000000..b9135f30c0 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12GraphicsCommandList6.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Heap1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Heap1.xml new file mode 100644 index 0000000000..9d3f20eb0f --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Heap1.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12PipelineLibrary1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12PipelineLibrary1.xml index ddce564475..758881a798 100644 --- a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12PipelineLibrary1.xml +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12PipelineLibrary1.xml @@ -3,7 +3,7 @@ - Retrieves the requested PSO from the library. The pipeline stream description is matched against the library database and remembered in order to prevent duplication of PSO contents. + Retrieves the requested PSO from the library. The pipeline stream description is matched against the library database, and remembered in order to prevent duplication of PSO contents. SAL: In @@ -12,11 +12,11 @@ SAL: In - Describes the required PSO using a structure. This description is matched against the library database and stored in order to prevent duplication of PSO contents. + Describes the required PSO using a structure. This description is matched against the library database, and stored in order to prevent duplication of PSO contents. - Specifies a REFIID for the ID3D12PipelineStateState object. - Applications should typically set this argument and the following argument, ppPipelineState, by using the macro IID_PPV_ARGS(&PSO1), where PSO1 is the name of the object. + Specifies a REFIID for the object. + Your app should typically set this argument and the following argument, ppPipelineState, by using the macro IID_PPV_ARGS(&PSO1), where PSO1 is the name of the object. diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12ProtectedResourceSession.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12ProtectedResourceSession.xml index 68265f2780..af38fae09c 100644 --- a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12ProtectedResourceSession.xml +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12ProtectedResourceSession.xml @@ -8,7 +8,7 @@ - Monitors the validity of a protected resource session. This interface extends . + Monitors the validity of a protected resource session. This interface extends . You can obtain an ID3D12ProtectedResourceSession by calling . diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Resource1.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Resource1.xml new file mode 100644 index 0000000000..8497f98922 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Resource1.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Resource2.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Resource2.xml new file mode 100644 index 0000000000..f3bf31d2a8 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12Resource2.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12SwapChainAssistant.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12SwapChainAssistant.xml new file mode 100644 index 0000000000..15c5d7c479 --- /dev/null +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12/ID3D12SwapChainAssistant.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12shader/ID3D12ShaderReflection.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12shader/ID3D12ShaderReflection.xml index 8a85d0a569..0e23475bbb 100644 --- a/sources/Interop/Windows/DirectX/d3d12/d3d12shader/ID3D12ShaderReflection.xml +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12shader/ID3D12ShaderReflection.xml @@ -37,6 +37,7 @@ Gets the minimum feature level. + A pointer to one of the enumerated values in , which represents the minimum feature level. Returns one of the Direct3D 12 Return Codes. diff --git a/sources/Interop/Windows/DirectX/d3d12/d3d12video/D3D12_VIDEO_PROCESS_SUPPORT_FLAGS.xml b/sources/Interop/Windows/DirectX/d3d12/d3d12video/D3D12_VIDEO_PROCESS_SUPPORT_FLAGS.xml index db986eccdf..26ee9b84b8 100644 --- a/sources/Interop/Windows/DirectX/d3d12/d3d12video/D3D12_VIDEO_PROCESS_SUPPORT_FLAGS.xml +++ b/sources/Interop/Windows/DirectX/d3d12/d3d12video/D3D12_VIDEO_PROCESS_SUPPORT_FLAGS.xml @@ -9,6 +9,6 @@ The conversion from the source format and colorspace to destination format and colorspace are not supported. - The conversion from the source format and colorspace to destination format and colorspace are are supported. + The conversion from the source format and colorspace to destination format and colorspace are supported. \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/DirectX.xml b/sources/Interop/Windows/DirectX/shared/d3d9/DirectX.xml new file mode 100644 index 0000000000..42f8290795 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/DirectX.xml @@ -0,0 +1,31 @@ + + + + + + Create an IDirect3D9 object and return an interface to it. + The value of this parameter should be D3D_SDK_VERSION. See Remarks. + If successful, this function returns a pointer to an interface; otherwise, a NULL pointer is returned. + + + Creates an object and returns an interface to it. + The value of this parameter should be D3D_SDK_VERSION. See Remarks. + Address of a pointer to an interface, representing the created IDirect3D9Ex object. If the function fails, NULL is inserted here. + + + + + D3DERR_NOTAVAILABLE if Direct3DEx features are not supported (no WDDM driver is installed) or if the SDKVersion does not match the version of the DLL. + + + + D3DERR_OUTOFMEMORY if out-of-memory conditions are detected when creating the enumerator object. + + + + S_OK if the creation of the enumerator object is successful. + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9.xml new file mode 100644 index 0000000000..e1d39b3dda --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9.xml @@ -0,0 +1,177 @@ + + + + + + Determines whether a depth-stencil format is compatible with a render-target format in a particular display mode. + Ordinal number denoting the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter. + Member of the D3DDEVTYPE enumerated type, identifying the device type. + Member of the D3DFORMAT enumerated type, identifying the format of the display mode into which the adapter will be placed. + Member of the D3DFORMAT enumerated type, identifying the format of the render-target surface to be tested. + Member of the D3DFORMAT enumerated type, identifying the format of the depth-stencil surface to be tested. + If the depth-stencil format is compatible with the render-target format in the display mode, this method returns D3D_OK. D3DERR_INVALIDCALL can be returned if one or more of the parameters is invalid. If a depth-stencil format is not compatible with the render target in the display mode, then this method returns D3DERR_NOTAVAILABLE. + + + Determines whether a surface format is available as a specified resource type and can be used as a texture, depth-stencil buffer, or render target, or any combination of the three, on a device representing this adapter. + Ordinal number denoting the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns D3DERR_INVALIDCALL when this value equals or exceeds the number of display adapters in the system. + Member of the D3DDEVTYPE enumerated type, identifying the device type. + Member of the D3DFORMAT enumerated type, identifying the format of the display mode into which the adapter will be placed. + Requested usage options for the surface. Usage options are any combination of D3DUSAGE and D3DUSAGE_QUERY constants (only a subset of the D3DUSAGE constants are valid for CheckDeviceFormat; see the table on the D3DUSAGE page). + Resource type requested for use with the queried format. Member of D3DRESOURCETYPE. + Format of the surfaces which may be used, as defined by Usage. Member of D3DFORMAT. + + If the format is compatible with the specified device for the requested usage, this method returns D3D_OK. + D3DERR_INVALIDCALL is returned if Adapter equals or exceeds the number of display adapters in the system, or if DeviceType is unsupported. + D3DERR_NOTAVAILABLE is returned if the format is not acceptable to the device for this usage. + + + + Tests the device to see if it supports conversion from one display format to another. + Display adapter ordinal number. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns D3DERR_INVALIDCALL when this value equals or exceeds the number of display adapters in the system. + Device type. Member of the D3DDEVTYPE enumerated type. + Source adapter format. Member of the D3DFORMAT enumerated type. + Target adapter format. Member of the D3DFORMAT enumerated type. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value is D3DERR_INVALIDCALL. The method will return D3DERR_NOTAVAILABLE when the hardware does not support conversion between the two formats. + + + Determines if a multisampling technique is available on this device. + Ordinal number denoting the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns FALSE when this value equals or exceeds the number of display adapters in the system. See Remarks. + Member of the D3DDEVTYPE enumerated type, identifying the device type. + Member of the D3DFORMAT enumerated type that specifies the format of the surface to be multisampled. For more information, see Remarks. + bool value. Specify TRUE to inquire about windowed multisampling, and specify FALSE to inquire about full-screen multisampling. + Member of the D3DMULTISAMPLE_TYPE enumerated type, identifying the multisampling technique to test. + + pQualityLevels returns the number of device-specific sampling variations available with the given sample type. For example, if the returned value is 3, then quality levels 0, 1 and 2 can be used when creating resources with the given sample count. The meanings of these quality levels are defined by the device manufacturer and cannot be queried through D3D. For example, for a particular device different quality levels at a fixed sample count might refer to different spatial layouts of the sample locations or different methods of resolving. This can be NULL if it is not necessary to return the quality levels. + If the device can perform the specified multisampling method, this method returns D3D_OK. D3DERR_INVALIDCALL is returned if the Adapter or MultiSampleType parameters are invalid. This method returns D3DERR_NOTAVAILABLE if the queried multisampling technique is not supported by this device. D3DERR_INVALIDDEVICE is returned if DeviceType does not apply to this adapter. + + + Verifies whether a hardware accelerated device type can be used on this adapter. + Ordinal number denoting the display adapter to enumerate. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns D3DERR_INVALIDCALL when this value equals or exceeds the number of display adapters in the system. + Member of the D3DDEVTYPE enumerated type, indicating the device type to check. + Member of the D3DFORMAT enumerated type, indicating the format of the adapter display mode for which the device type is to be checked. For example, some devices will operate only in 16-bits-per-pixel modes. + + Back buffer format. For more information about formats, see D3DFORMAT. This value must be one of the render-target formats. You can use to obtain the current format. + For windowed applications, the back buffer format does not need to match the display mode format if the hardware supports color conversion. The set of possible back buffer formats is constrained, but the runtime will allow any valid back buffer format to be presented to any desktop format. There is the additional requirement that the device be operable in the desktop because devices typically do not operate in 8 bits per pixel modes. + Full-screen applications cannot do color conversion. + D3DFMT_UNKNOWN is allowed for windowed mode. + + Value indicating whether the device type will be used in full-screen or windowed mode. If set to TRUE, the query is performed for windowed applications; otherwise, this value should be set FALSE. + + If the device can be used on this adapter, D3D_OK is returned. + D3DERR_INVALIDCALL is returned if Adapter equals or exceeds the number of display adapters in the system. D3DERR_INVALIDCALL is also returned if CheckDeviceType specified a device that does not exist. + D3DERR_NOTAVAILABLE is returned if the requested back buffer format is not supported, or if hardware acceleration is not available for the specified formats. + + + + Creates a device to represent the display adapter. + Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter. + Member of the D3DDEVTYPE enumerated type that denotes the desired device type. If the desired device type is not available, the method will fail. + + The focus window alerts Direct3D when an application switches from foreground mode to background mode. See Remarks. + + + For full-screen mode, the window specified must be a top-level window. + + + For windowed mode, this parameter may be NULL only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-NULL value. + + + + Combination of one or more options that control device creation. For more information, see D3DCREATE. + + Pointer to a D3DPRESENT_PARAMETERS structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies D3DCREATE_ADAPTERGROUP_DEVICE, pPresentationParameters is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created. + For Windows 2000 and Windows XP, the full-screen device display refresh rate is set in the following order: + + + User-specified nonzero ForcedRefreshRate registry key, if supported by the device. + + + Application-specified nonzero refresh rate value in the presentation parameter. + + + Refresh rate of the latest desktop, if supported by the device. + + + 75 hertz if supported by the device. + + + 60 hertz if supported by the device. + + + Device default. + + An unsupported refresh rate will default to the closest supported refresh rate below it. For example, if the application specifies 63 hertz, 60 hertz will be used. There are no supported refresh rates below 57 hertz.pPresentationParameters is both an input and an output parameter. Calling this method may change several members including:If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns.If BackBufferFormat equals D3DFMT_UNKNOWN before the method is called, it will be changed when the method returns. + Address of a pointer to the returned interface, which represents the created device. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_DEVICELOST, D3DERR_INVALIDCALL, D3DERR_NOTAVAILABLE, D3DERR_OUTOFVIDEOMEMORY. + + + Queries the device to determine whether the specified adapter supports the requested format and display mode. This method could be used in a loop to enumerate all the available adapter modes. + Ordinal number denoting the display adapter to enumerate. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns D3DERR_INVALIDCALL when this value equals or exceeds the number of display adapters in the system. + Allowable pixel formats. See Remarks. + Represents the display-mode index which is an unsigned integer between zero and the value returned by minus one. + A pointer to the available display mode of type D3DDISPLAYMODE. See Remarks. + + + + If the device can be used on this adapter, D3D_OK is returned. + + + If the Adapter equals or exceeds the number of display adapters in the system, D3DERR_INVALIDCALL is returned. + + + If either surface format is not supported or if hardware acceleration is not available for the specified formats, D3DERR_NOTAVAILABLE is returned. + + + + + + Returns the number of adapters on the system. + A UINT value that denotes the number of adapters on the system at the time this interface was instantiated. + + + Retrieves the current display mode of the adapter. + Ordinal number that denotes the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter. + Pointer to a D3DDISPLAYMODE structure, to be filled with information describing the current adapter's mode. + + If the method succeeds, the return value is D3D_OK. + If Adapter is out of range or pMode is invalid, this method returns D3DERR_INVALIDCALL. + + + + Describes the physical display adapters present in the system when the interface was instantiated. + Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter. The minimum value for this parameter is 0, and the maximum value for this parameter is one less than the value returned by . + + Flags sets the WHQLLevel member of D3DADAPTER_IDENTIFIER9. Flags can be set to either 0 or D3DENUM_WHQL_LEVEL. If D3DENUM_WHQL_LEVEL is specified, this call can connect to the Internet to download new Microsoft Windows Hardware Quality Labs (WHQL) certificates. + Differences between Direct3D 9 and Direct3D 9Ex: + D3DENUM_WHQL_LEVEL is deprecated for Direct3D9Ex running on Windows Vista, Windows Server 2008, Windows 7, and Windows Server 2008 R2 (or more current operating system). Any of these operating systems return 1 in the WHQLLevel member of D3DADAPTER_IDENTIFIER9 without checking the status of the driver. + + Pointer to a D3DADAPTER_IDENTIFIER9 structure to be filled with information describing this adapter. If Adapter is greater than or equal to the number of adapters in the system, this structure will be zeroed. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if Adapter is out of range, if Flags contains unrecognized parameters, or if pIdentifier is NULL or points to unwritable memory. + + + Returns the number of display modes available on this adapter. + Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter. + Identifies the format of the surface type using D3DFORMAT. Use to see the valid formats. + This method returns the number of display modes on this adapter or zero if Adapter is greater than or equal to the number of adapters on the system. + + + Returns the handle of the monitor associated with the Direct3D object. + Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter. + Handle of the monitor associated with the Direct3D object. + + + Retrieves device-specific information about a device. + Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter. + Member of the D3DDEVTYPE enumerated type. Denotes the device type. + Pointer to a structure to be filled with information describing the capabilities of the device. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_INVALIDDEVICE, D3DERR_OUTOFVIDEOMEMORY, and D3DERR_NOTAVAILABLE. + + + Registers a pluggable software device. Software devices provide software rasterization enabling applications to access a variety of software rasterizers. + Pointer to the initialization function for the software device to be registered. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL. The method call is invalid. For example, a method's parameter may have an invalid value: D3DERR_OUTOFVIDEOMEMORY. + + + Applications use the methods of the IDirect3D9 interface to create Microsoft Direct3D objects and set up the environment. This interface includes methods for enumerating and retrieving capabilities of the device. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9Ex.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9Ex.xml new file mode 100644 index 0000000000..a97f765aa4 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9Ex.xml @@ -0,0 +1,69 @@ + + + + + + Creates a device to represent the display adapter. + Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter. + Specifies the type of device. See D3DDEVTYPE. If the desired device type is not available, the method will fail. + The focus window alerts Direct3D when an application switches from foreground mode to background mode. For full-screen mode, the window specified must be a top-level window. For windowed mode, this parameter may be NULL only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-NULL value. + Combination of one or more options (see D3DCREATE) that control device creation. + + Pointer to a D3DPRESENT_PARAMETERS structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies D3DCREATE_ADAPTERGROUP_DEVICE, this parameter is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created. + This parameter is both an input and an output parameter. Calling this method may change several members including: + + + If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns. + + + If BackBufferFormat equals D3DFMT_UNKNOWN before the method is called, it will be changed when the method returns. + + + + The display mode for when the device is set to fullscreen. See D3DDISPLAYMODEEX. If BehaviorFlags specifies D3DCREATE_ADAPTERGROUP_DEVICE, this parameter is an array. This parameter must be NULL for windowed mode. + Address of a pointer to the returned , which represents the created device. + This method returns S_OK when rendering device along with swapchain buffers are created successfully. D3DERR_DEVICELOST is returned when any error other than invalid caller input is encountered. + + + This method returns the actual display mode info based on the given mode index. + Ordinal number denoting the display adapter to enumerate. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns D3DERR_INVALIDCALL when this value equals or exceeds the number of display adapters in the system. + See D3DDISPLAYMODEFILTER. + Represents the display-mode index which is an unsigned integer between zero and the value returned by GetAdapterModeCount minus one. + A pointer to the available display mode of type D3DDISPLAYMODEEX. + + + + If the device can be used on this adapter, D3D_OK is returned. + + + If the Adapter equals or exceeds the number of display adapters in the system, D3DERR_INVALIDCALL is returned. + + + + + + Retrieves the current display mode and rotation settings of the adapter. + Ordinal number that denotes the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter. + Pointer to a D3DDISPLAYMODEEX structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode. Can be set to NULL. + Pointer to a D3DDISPLAYROTATION structure indicating the type of screen rotation the application will do. The value returned through this pointer is important when the D3DPRESENTFLAG_NOAUTOROTATE flag is used; otherwise, it can be set to NULL. + + If the method succeeds, the return value is D3D_OK. + If Adapter is out of range or pMode is invalid, this method returns D3DERR_INVALIDCALL. + + + + This method returns a unique identifier for the adapter that is specific to the adapter hardware. Applications can use this identifier to define robust mappings across various APIs (Direct3D 9, DXGI). + Ordinal number denoting the display adapter from which to retrieve the LUID. + A unique identifier for the given adapter. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Returns the number of display modes available. + Ordinal number denoting the display adapter from which to retrieve the display mode count. + Specifies the characteristics of the desired display mode. See D3DDISPLAYMODEFILTER. + The number of display modes available. A return of value zero from this method is an indication that no such display mode is supported or simply this monitor is no longer available. + + + Applications use the methods of the IDirect3D9Ex interface (which inherits from ) to create Microsoft Direct3D 9Ex objects and set up the environment. This interface includes methods for enumerating and retrieving capabilities of the device and is available when the underlying device implementation is compliant with Windows Vista. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9ExOverlayExtension.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9ExOverlayExtension.xml new file mode 100644 index 0000000000..fcce037f87 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3D9ExOverlayExtension.xml @@ -0,0 +1,67 @@ + + + + + + Queries the overlay hardware capabilities of a Direct3D device. + An ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter. + Specifies the Direct3D device type as a member of the D3DDEVTYPE enumerated type. + The width of the overlay to create, in pixels. + The height of the overlay to create, in pixels. + The surface format of the overlay. + A pointer to a D3DDISPLAYMODEEX structure that specifies the display mode that will be used. If this parameter is NULL, the current display mode is assumed. + Specifies the display rotation mode as a member of the D3DDISPLAYROTATION enumerated type. + A pointer to a structure. If the driver supports the overlay settings specified in the input parameters, the method fills this structure with the capabilities of the overlay hardware. + + This method can return one of these values. + + + Return code + Description + + + + + + + D3DERR_INVALIDCALL + + + + + Invalid parameter, or the device does not support hardware overlay. + + + + + + + D3DERR_UNSUPPORTEDOVERLAY + + + + + The device does not support overlay for the specified size or display mode. + + + + + + + D3DERR_UNSUPPORTEDOVERLAYFORMAT + + + + + The device does not support overlay for the specified surface format. + + + + + + + Queries the overlay hardware capabilities of a Direct3D device. + To get a pointer to this interface, call QueryInterface on an IDirect3D9Ex interface pointer. + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DAuthenticatedChannel9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DAuthenticatedChannel9.xml new file mode 100644 index 0000000000..57eb2344d5 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DAuthenticatedChannel9.xml @@ -0,0 +1,43 @@ + + + + + + Sends a configuration command to the authenticated channel. + The size of the pInput array, in bytes. + A pointer to a byte array that contains input data for the command. This buffer always starts with a D3DAUTHENTICATEDCHANNEL_CONFIGURE_INPUT structure. The ConfigureType member of the structure specifies the command and defines the meaning of the rest of the buffer. + A pointer to a D3DAUTHENTICATEDCHANNEL_CONFIGURE_OUTPUT structure that receives the response to the command. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the driver's certificate chain. + The size of the ppCertificate array, in bytes. To get the size of the certificate chain, call . + A pointer to a byte array that receives the driver's X.509 certificate chain. The caller must allocate the array. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the size of the driver's certificate chain. + Receives the size of the certificate chain, in bytes. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Establishes a session key for the authenticated channel. + The size of the data in the pData array, in bytes. + A pointer to a byte array that contains the encrypted session key. The buffer must contain 256 bytes of data, encrypted using RSA Encryption Scheme - Optimal Asymmetric Encryption Padding (RSAES-OAEP). + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Sends a query to the authenticated channel. + The size of the pInput array, in bytes. + A pointer to a byte array that contains input data for the query. This array always starts with a D3DAUTHENTICATEDCHANNEL_QUERY_INPUT structure. The QueryType member of the structure specifies the query and defines the meaning of the rest of the array. + The size of the pOutput array, in bytes. + A pointer to a byte array that receives the result of the query. This array always starts with a D3DAUTHENTICATEDCHANNEL_QUERY_OUTPUT structure. The meaning of the rest of the array depends on the query. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + + Provides a communication channel with the graphics driver or the Direct3D runtime. + To get a pointer to this interface, call . + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DBaseTexture9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DBaseTexture9.xml new file mode 100644 index 0000000000..cc9bb3a1d8 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DBaseTexture9.xml @@ -0,0 +1,33 @@ + + + + + + Generate mipmap sublevels. + + + Get the filter type that is used for automatically generated mipmap sublevels. + Filter type. See D3DTEXTUREFILTERTYPE. A texture must be created with D3DUSAGE_AUTOGENMIPMAP to use this method. Any other usage value will cause this method to return D3DTEXF_NONE. + + + Returns the number of texture levels in a multilevel texture. + A DWORD value that indicates the number of texture levels in a multilevel texture. + + + Returns a value clamped to the maximum level-of-detail set for a managed texture (this method is not supported for an unmanaged texture). + A DWORD value, clamped to the maximum level-of-detail value (one less than the total number of levels). Calling GetLOD on an unmanaged texture is not supported and will result in a D3DERR error code being returned. + + + Set the filter type that is used for automatically generated mipmap sublevels. + Filter type. See D3DTEXTUREFILTERTYPE. This method will fail if the filter type is invalid or not supported. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the most detailed level-of-detail for a managed texture. + Most detailed level-of-detail value to set for the mipmap chain. + A DWORD value, clamped to the maximum level-of-detail value (one less than the total number of levels). Subsequent calls to this method will return the clamped value, not the level-of-detail value that was previously set. + + + Applications use the methods of the IDirect3DBaseTexture9 interface to manipulate texture resources including cube and volume textures. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DCryptoSession9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DCryptoSession9.xml new file mode 100644 index 0000000000..6801fc6604 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DCryptoSession9.xml @@ -0,0 +1,83 @@ + + + + + + Writes encrypted data to a protected surface. + A pointer to the surface that contains the source data. + A pointer to the protected surface where the encrypted data is written. + The size of the surface memory that pSrcSurface points to, in bytes. The size must be aligned to the value of BlockAlignmentSize in the driver capabilities structure; see Remarks. + + A pointer to a D3DENCRYPTED_BLOCK_INFO structure, or NULL. + If the driver supports partially encrypted buffers, pEncryptedBlockInfo indicates which portions of the buffer are encrypted. If the entire surface is encrypted, set this parameter to NULL. + To check whether the driver supports partially encrypted buffers, call and check for the D3DCPCAPS_PARTIALDECRYPTION capabilities flag. If the driver does not support partially encrypted buffers, set this parameter to NULL. + + + A pointer to a buffer that contains a content encryption key, or NULL. To query whether the driver supports the use of content keys, call and check for the D3DCPCAPS_CONTENTKEY capabilities flag. + If the driver supports content keys, use the content key to encrypt the surface. Encrypt the content key using the session key, and place the resulting cipher text in pContentKey. If the driver does not support content keys, use the session key to encrypt the surface and set pContentKey to NULL. + + + A pointer to a buffer that contains the initialization vector (IV). + If the encryption type is D3DCRYPTOTYPE_AES128_CTR, the buffer is a D3DAES_CTR_IV structure. The caller allocates the structure and generates the IV. When you generate the first IV, initialize the structure to a random number. For each subsequent IV, simply increment the IV member of the structure, ensuring that the value always increases. This procedure enables the driver to validate that the same IV is never used more than once with the same key pair. + For other encryption types, a different structure might be used, or the encryption might not use an IV. + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Reads encrypted data from a protected surface. + Pointer to the protected surface. + Pointer to a surface that receives the encrypted data. + The size of the surface memory that pDstSurface points to, in bytes. The size must be aligned to the value of BlockAlignmentSize in the driver capabilities structure; see Remarks. + + Pointer to a buffer that receives the initialization vector (IV). The caller allocates this buffer, but the driver generates the IV. + If the encryption type is D3DCRYPTOTYPE_AES128_CTR (128-bit AES-CTR), pIV points to a D3DAES_CTR_IV structure. When the driver generates the first IV, it initializes the structure to a random number. For each subsequent IV, the driver simply increments the IV member of the structure, ensuring that the value always increases. This procedure enables the application to validate that the same IV is never used more than once with the same key pair. + For other encryption types, a different structure might be used, or the encryption might not use an IV. + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Switches to a new session key. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the driver's certificate chain. + The size of the ppCertificate array, in bytes. To get the size of the certificate chain, call . + A pointer to a byte array that receives the driver's certificate chain. The caller must allocate the array. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the size of the driver's certificate chain. + Receives the size of the certificate chain, in bytes. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the cryptographic key used to decrypt the data returned by the method. + A pointer to a byte array that receives the key. The key is encrypted using the session key. + The size of the pReadbackKey array, in bytes. The size should match the size of the session key. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the stride of a protected surface. + Pointer to the protected surface. + Receives the stride, in bytes. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Establishes the session key for the cryptographic session. + The size of the pData byte array, in bytes. + A pointer to a byte array that contains the encrypted session key. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets a random number that can be used to refresh the session key. + A pointer to a byte array that receives a random number. + The size of the pRandomNumber array, in bytes. The size should match the size of the session key. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + + Represents a cryptographic session. + To get a pointer to this interface, call . + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DCubeTexture9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DCubeTexture9.xml new file mode 100644 index 0000000000..17b161e600 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DCubeTexture9.xml @@ -0,0 +1,57 @@ + + + + + + Adds a dirty region to a cube texture resource. + Member of the D3DCUBEMAP_FACES enumerated type, identifying the cube map face. + Pointer to a structure, specifying the dirty region. Specifying NULL expands the dirty region to cover the entire cube texture. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Retrieves a cube texture map surface. + Member of the D3DCUBEMAP_FACES enumerated type, identifying a cube map face. + Specifies a level of a mipmapped cube texture. + Address of a pointer to an interface, representing the returned cube texture map surface. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Retrieves a description of one face of the specified cube texture level. + Specifies a level of a mipmapped cube texture. + Pointer to a D3DSURFACE_DESC structure, describing one face of the specified cube texture level. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Locks a rectangle on a cube texture resource. + Member of the D3DCUBEMAP_FACES enumerated type, identifying a cube map face. + Specifies a level of a mipmapped cube texture. + Pointer to a D3DLOCKED_RECT structure, describing the region to lock. + Pointer to a rectangle to lock. Specified by a pointer to a structure. Specifying NULL for this parameter expands the dirty region to cover the entire cube texture. + + Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are: + + + D3DLOCK_DISCARD + + + D3DLOCK_NO_DIRTY_UPDATE + + + D3DLOCK_NOSYSLOCK + + + D3DLOCK_READONLY + + You may not specify a subrect when using D3DLOCK_DISCARD. For a description of the flags, see D3DLOCK. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if one or more of the arguments is invalid. + + + Unlocks a rectangle on a cube texture resource. + Member of the D3DCUBEMAP_FACES enumerated type, identifying a cube map face. + Specifies a level of a mipmapped cube texture. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DCubeTexture9 interface to manipulate a cube texture resource. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9.xml new file mode 100644 index 0000000000..b77dd51504 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9.xml @@ -0,0 +1,914 @@ + + + + + + Begins a scene. + If the method succeeds, the return value is D3D_OK. The method will fail with D3DERR_INVALIDCALL if IDirect3DDevice9.BeginScene is called while already in a IDirect3DDevice9.BeginScene/ pair. This happens only when IDirect3DDevice9.BeginScene is called twice without first calling IDirect3DDevice9.EndScene. + + + Signals Direct3D to begin recording a device-state block. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, E_OUTOFMEMORY. + + + Clears one or more surfaces such as a render target, multiple render targets, a stencil buffer, and a depth buffer. + Number of rectangles in the array at pRects. Must be set to 0 if pRects is NULL. May not be 0 if pRects is a valid pointer. + Pointer to an array of D3DRECT structures that describe the rectangles to clear. Set a rectangle to the dimensions of the rendering target to clear the entire surface. Each rectangle uses screen coordinates that correspond to points on the render target. Coordinates are clipped to the bounds of the viewport rectangle. To indicate that the entire viewport rectangle is to be cleared, set this parameter to NULL and Count to 0. + Combination of one or more D3DCLEAR flags that specify the surface(s) that will be cleared. + Clear a render target to this ARGB color. + Clear the depth buffer to this new z value which ranges from 0 to 1. See remarks. + Clear the stencil buffer to this new value which ranges from 0 to 2ⁿ-1 (n is the bit depth of the stencil buffer). See remarks. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Allows an application to fill a rectangular area of a D3DPOOL_DEFAULT surface with a specified color. + Pointer to the surface to be filled. + Pointer to the source rectangle. Using NULL means that the entire surface will be filled. + Color used for filling. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Creates an additional swap chain for rendering multiple views. + + Pointer to a D3DPRESENT_PARAMETERS structure, containing the presentation parameters for the new swap chain. This value cannot be NULL. + Calling this method changes the value of members of the D3DPRESENT_PARAMETERS structure. + + + If BackBufferCount == 0, calling CreateAdditionalSwapChain will increase it to 1. + + + If the application is in windowed mode, and if either the BackBufferWidth or the BackBufferHeight == 0, they will be set to the client area width and height of the hwnd. + + + + Address of a pointer to an interface, representing the additional swap chain. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_NOTAVAILABLE, D3DERR_DEVICELOST, D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Creates a cube texture resource. + Size of the edges of all the top-level faces of the cube texture. The pixel dimensions of subsequent levels of each face will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0 (zero), 1 will be taken instead. + Number of levels in each face of the cube texture. If this is zero, Direct3D will generate all cube texture sublevels down to 1x1 pixels for each face for hardware that supports mipmapped cube textures. Call to see the number of levels generated. + Usage can be 0, which indicates no usage value. However, if usage is desired, use a combination of one or more D3DUSAGE constants. It is good practice to match the usage parameter in CreateCubeTexture with the behavior flags in . For more information, see Remarks. + Member of the D3DFORMAT enumerated type, describing the format of all levels in all faces of the cube texture. + Member of the D3DPOOL enumerated type, describing the memory class into which the cube texture should be placed. + Address of a pointer to an interface, representing the created cube texture resource. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Creates a depth-stencil resource. + Width of the depth-stencil surface, in pixels. + Height of the depth-stencil surface, in pixels. + Member of the D3DFORMAT enumerated type, describing the format of the depth-stencil surface. This value must be one of the enumerated depth-stencil formats for this device. + Member of the D3DMULTISAMPLE_TYPE enumerated type, describing the multisampling buffer type. This value must be one of the allowed multisample types. When this surface is passed to , its multisample type must be the same as that of the render target set by . + Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by . Passing a larger value returns the error D3DERR_INVALIDCALL. The MultisampleQuality values of paired render targets, depth stencil surfaces, and the MultiSample type must all match. + + Set this flag to TRUE to enable z-buffer discarding, and FALSE otherwise. If this flag is set, the contents of the depth stencil buffer will be invalid after calling either or with a different depth surface. + This flag has the same behavior as the constant, D3DPRESENTFLAG_DISCARD_DEPTHSTENCIL, in D3DPRESENTFLAG. + + Address of a pointer to an interface, representing the created depth-stencil surface resource. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_NOTAVAILABLE, D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Creates an index buffer. + Size of the index buffer, in bytes. + Usage can be 0, which indicates no usage value. However, if usage is desired, use a combination of one or more D3DUSAGE constants. It is good practice to match the usage parameter in CreateIndexBuffer with the behavior flags in . For more information, see Remarks. + + Member of the D3DFORMAT enumerated type, describing the format of the index buffer. For more information, see Remarks. The valid settings are the following: + + + Item + Description + + + D3DFMT_INDEX16 + Indices are 16 bits each. + + + D3DFMT_INDEX32 + Indices are 32 bits each. + + + + Member of the D3DPOOL enumerated type, describing a valid memory class into which to place the resource. + Address of a pointer to an interface, representing the created index buffer resource. + This parameter can be used in Direct3D 9 for Windows Vista to share resources; set it to NULL to not share a resource. This parameter is not used in Direct3D 9 for operating systems earlier than Windows Vista; set it to NULL. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, D3DXERR_INVALIDDATA, E_OUTOFMEMORY. + + + Create an off-screen surface. + Width of the surface. + Height of the surface. + Format of the surface. See D3DFORMAT. + Surface pool type. See D3DPOOL. + Pointer to the interface created. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be the following: D3DERR_INVALIDCALL. + + + Creates a pixel shader. + Pointer to the pixel shader function token array, specifying the blending operations. This value cannot be NULL. + Pointer to the returned pixel shader interface. See . + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Creates a status query. + Identifies the query type. For more information, see D3DQUERYTYPE. + + Returns a pointer to the query interface that manages the query object. See . + This parameter can be set to NULL to see if a query is supported. If the query is not supported, the method returns D3DERR_NOTAVAILABLE. + + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_NOTAVAILABLE or E_OUTOFMEMORY. + + + Creates a render-target surface. + Width of the render-target surface, in pixels. + Height of the render-target surface, in pixels. + Member of the D3DFORMAT enumerated type, describing the format of the render target. + Member of the D3DMULTISAMPLE_TYPE enumerated type, which describes the multisampling buffer type. This parameter specifies the antialiasing type for this render target. When this surface is passed to , its multisample type must be the same as that of the depth-stencil set by . + Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by . Passing a larger value returns the error, D3DERR_INVALIDCALL. The MultisampleQuality values of paired render targets, depth stencil surfaces, and the multisample type must all match. + + Render targets are not lockable unless the application specifies TRUE for Lockable. + Note that lockable render targets reduce performance on some graphics hardware. The readback performance (moving data from video memory to system memory) depends on the type of hardware used (AGP vs. PCI Express) and is usually far lower than upload performance (moving data from system to video memory). If you need read access to render targets, use instead of lockable render targets. + + Address of a pointer to an interface. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_NOTAVAILABLE, D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Creates a new state block that contains the values for all device states, vertex-related states, or pixel-related states. + Type of state data that the method should capture. This parameter can be set to a value defined in the D3DSTATEBLOCKTYPE enumerated type. + Pointer to a state block interface. See . + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Creates a texture resource. + Width of the top-level of the texture, in pixels. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0, 1 will be taken instead. + Height of the top-level of the texture, in pixels. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0, 1 will be taken instead. + Number of levels in the texture. If this is zero, Direct3D will generate all texture sublevels down to 1 by 1 pixels for hardware that supports mipmapped textures. Call to see the number of levels generated. + Usage can be 0, which indicates no usage value. However, if usage is desired, use a combination of one or more D3DUSAGE constants. It is good practice to match the usage parameter with the behavior flags in . + Member of the D3DFORMAT enumerated type, describing the format of all levels in the texture. + Member of the D3DPOOL enumerated type, describing the memory class into which the texture should be placed. + Pointer to an interface, representing the created texture resource. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista toshare resources. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Creates a vertex buffer. + Size of the vertex buffer, in bytes. For FVF vertex buffers, Length must be large enough to contain at least one vertex, but it need not be a multiple of the vertex size. Length is not validated for non-FVF buffers. See Remarks. + Usage can be 0, which indicates no usage value. However, if usage is desired, use a combination of one or more D3DUSAGE constants. It is good practice to match the usage parameter in CreateVertexBuffer with the behavior flags in . For more information, see Remarks. + Combination of D3DFVF, a usage specifier that describes the vertex format of the vertices in this buffer. If this parameter is set to a valid FVF code, the created vertex buffer is an FVF vertex buffer (see Remarks). Otherwise, if this parameter is set to zero, the vertex buffer is a non-FVF vertex buffer. + Member of the D3DPOOL enumerated type, describing a valid memory class into which to place the resource. Do not set to D3DPOOL_SCRATCH. + Address of a pointer to an interface, representing the created vertex buffer resource. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Create a vertex shader declaration from the device and the vertex elements. + An array of D3DVERTEXELEMENT9 vertex elements. + Pointer to an pointer that returns the created vertex shader declaration. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Creates a vertex shader. + + Pointer to an array of tokens that represents the vertex shader, including any embedded debug and symbol table information. + + + Use a function such as D3DXCompileShader to create the array from a HLSL shader. + + + Use a function like D3DXAssembleShader to create the token array from an assembly language shader. + + + Use a function like ID3DXEffectCompiler.CompileShader to create the array from an effect. + + + + Pointer to the returned vertex shader interface (see ). + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Creates a volume texture resource. + Width of the top-level of the volume texture, in pixels. This value must be a power of two if the D3DPTEXTURECAPS_VOLUMEMAP_POW2 member of is set. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by two results in 0 (zero), 1 will be taken instead. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in D3DCAPS9. + Height of the top-level of the volume texture, in pixels. This value must be a power of two if the D3DPTEXTURECAPS_VOLUMEMAP_POW2 member of is set. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0 (zero), 1 will be taken instead. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in D3DCAPS9. + Depth of the top-level of the volume texture, in pixels. This value must be a power of two if the D3DPTEXTURECAPS_VOLUMEMAP_POW2 member of is set. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0 (zero), 1 will be taken instead. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in D3DCAPS9. + Number of levels in the texture. If this is zero, Direct3D will generate all texture sublevels down to 1x1 pixels for hardware that supports mipmapped volume textures. Call to see the number of levels generated. + Usage can be 0, which indicates no usage value. If usage is desired, use D3DUSAGE_DYNAMIC or D3DUSAGE_SOFTWAREPROCESSING. For more information, see D3DUSAGE. + Member of the D3DFORMAT enumerated type, describing the format of all levels in the volume texture. + Member of the D3DPOOL enumerated type, describing the memory class into which the volume texture should be placed. + Address of a pointer to an interface, representing the created volume texture resource. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Frees a cached high-order patch. + Handle of the cached high-order patch to delete. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Based on indexing, renders the specified geometric primitive into an array of vertices. + Member of the D3DPRIMITIVETYPE enumerated type, describing the type of primitive to render. D3DPT_POINTLIST is not supported with this method. See Remarks. + Offset from the start of the vertex buffer to the first vertex. See Scenario 4. + Minimum vertex index for vertices used during this call. This is a zero based index relative to BaseVertexIndex. + Number of vertices used during this call. The first vertex is located at index: BaseVertexIndex + MinIndex. + Index of the first index to use when accessing the vertex buffer. Beginning at StartIndex to index vertices from the vertex buffer. + Number of primitives to render. The number of vertices used is a function of the primitive count and the primitive type. The maximum number of primitives allowed is determined by checking the MaxPrimitiveCount member of the structure. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be the following: D3DERR_INVALIDCALL. + + + Renders the specified geometric primitive with data specified by a user memory pointer. + Member of the D3DPRIMITIVETYPE enumerated type, describing the type of primitive to render. + Minimum vertex index. This is a zero-based index. + Number of vertices used during this call. The first vertex is located at index: MinVertexIndex. + Number of primitives to render. The maximum number of primitives allowed is determined by checking the MaxPrimitiveCount member of the structure (the number of indices is a function of the primitive count and the primitive type). + User memory pointer to the index data. + + Member of the D3DFORMAT enumerated type, describing the format of the index data. The valid settings are either: + + + + D3DFMT_INDEX16 + + + + + D3DFMT_INDEX32 + + + + + User memory pointer to the vertex data. The vertex data must be in stream 0. + The number of bytes of data for each vertex. This value may not be 0. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be the following: D3DERR_INVALIDCALL. + + + Renders a sequence of nonindexed, geometric primitives of the specified type from the current set of data input streams. + Member of the D3DPRIMITIVETYPE enumerated type, describing the type of primitive to render. + Index of the first vertex to load. Beginning at StartVertex the correct number of vertices will be read out of the vertex buffer. + Number of primitives to render. The maximum number of primitives allowed is determined by checking the MaxPrimitiveCount member of the structure. PrimitiveCount is the number of primitives as determined by the primitive type. If it is a line list, each primitive has two vertices. If it is a triangle list, each primitive has three vertices. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Renders data specified by a user memory pointer as a sequence of geometric primitives of the specified type. + Member of the D3DPRIMITIVETYPE enumerated type, describing the type of primitive to render. + Number of primitives to render. The maximum number of primitives allowed is determined by checking the MaxPrimitiveCount member of the structure. + User memory pointer to the vertex data. + The number of bytes of data for each vertex. This value may not be 0. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Draws a rectangular patch using the currently set streams. + Handle to the rectangular patch to draw. + Pointer to an array of four floating-point values that identify the number of segments each edge of the rectangle patch should be divided into when tessellated. See D3DRECTPATCH_INFO. + Pointer to a D3DRECTPATCH_INFO structure, describing the rectangular patch to draw. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Draws a triangular patch using the currently set streams. + Handle to the triangular patch to draw. + Pointer to an array of three floating-point values that identify the number of segments each edge of the triangle patch should be divided into when tessellated. See D3DTRIPATCH_INFO. + Pointer to a D3DTRIPATCH_INFO structure, describing the triangular high-order patch to draw. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Ends a scene that was begun by calling . + If the method succeeds, the return value is D3D_OK. The method will fail with D3DERR_INVALIDCALL if is called while already in a IDirect3DDevice9.BeginScene/IDirect3DDevice9.EndScene pair. This happens only when IDirect3DDevice9.BeginScene is called twice without first calling IDirect3DDevice9.EndScene. + + + Signals Direct3D to stop recording a device-state block and retrieve a pointer to the state block interface. + Pointer to a state block interface. See . + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Evicts all managed resources, including both Direct3D and driver-managed resources. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_OUTOFVIDEOMEMORY, D3DERR_COMMAND_UNPARSED. + + + Returns an estimate of the amount of available texture memory. + The function returns an estimate of the available texture memory. + + + Retrieves a back buffer from the device's swap chain. + An unsigned integer specifying the swap chain. + Index of the back buffer object to return. Back buffers are numbered from 0 to the total number of back buffers minus one. A value of 0 returns the first back buffer, not the front buffer. The front buffer is not accessible through this method. Use to retrieve a copy of the front buffer. + Stereo view is not supported in Direct3D 9, so the only valid value for this parameter is D3DBACKBUFFER_TYPE_MONO. + Address of a pointer to an interface, representing the returned back buffer surface. + If the method succeeds, the return value is D3D_OK. If BackBuffer equals or exceeds the total number of back buffers, then the function fails and returns D3DERR_INVALIDCALL. + + + Retrieves the coefficients of a user-defined clipping plane for the device. + Index of the clipping plane for which the plane equation coefficients are retrieved. + Pointer to a four-element array of values that represent the coefficients of the clipping plane in the form of the general plane equation. See Remarks. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value is D3DERR_INVALIDCALL. This error indicates that the value in Index exceeds the maximum clipping plane index supported by the device, or that the array at pPlane is not large enough to contain four floating-point values. + + + Retrieves the clip status. + Pointer to a D3DCLIPSTATUS9 structure that describes the clip status. + + If the method succeeds, the return value is D3D_OK. + D3DERR_INVALIDCALL is returned if the argument is invalid. + + + + Retrieves the creation parameters of the device. + Pointer to a D3DDEVICE_CREATION_PARAMETERS structure, describing the creation parameters of the device. + + If the method succeeds, the return value is D3D_OK. + D3DERR_INVALIDCALL is returned if the argument is invalid. + + + + Retrieves the current texture palette. + Pointer to a returned value that identifies the current texture palette. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Gets the depth-stencil surface owned by the Direct3DDevice object. + Address of a pointer to an interface, representing the returned depth-stencil surface. + If the method succeeds, the return value is D3D_OK.If the device doesn't have a depth stencil buffer associated with it, the return value will be D3DERR_NOTFOUND. Otherwise, if the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the capabilities of the rendering device. + Pointer to a structure, describing the returned device. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Returns an interface to the instance of the Direct3D object that created the device. + Address of a pointer to an interface, representing the interface of the Direct3D object that created the device. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the display mode's spatial resolution, color resolution, and refresh frequency. + An unsigned integer specifying the swap chain. + Pointer to a D3DDISPLAYMODE structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Generates a copy of the device's front buffer and places that copy in a system memory buffer provided by the application. + An unsigned integer specifying the swap chain. + + Pointer to an interface that will receive a copy of the contents of the front buffer. The data is returned in successive rows with no intervening space, starting from the vertically highest row on the device's output to the lowest. + For windowed mode, the size of the destination surface should be the size of the desktop. For full-screen mode, the size of the destination surface should be the screen size. + + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_DRIVERINTERNALERROR, D3DERR_DEVICELOST, D3DERR_INVALIDCALL + + + Gets the fixed vertex function declaration. + A DWORD pointer to the fixed function vertex type. For more information, see D3DFVF. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the gamma correction ramp for the swap chain. + An unsigned integer specifying the swap chain. + Pointer to an application-supplied D3DGAMMARAMP structure to fill with the gamma correction ramp. + + + Retrieves index data. + Address of a pointer to an interface, representing the returned index data. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves a set of lighting properties that this device uses. + Zero-based index of the lighting property set to retrieve. This method will fail if a lighting property has not been set for this index by calling the method. + Pointer to a D3DLIGHT9 structure that is filled with the retrieved lighting-parameter set. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the activity status - enabled or disabled - for a set of lighting parameters within a device. + Zero-based index of the set of lighting parameters that are the target of this method. + Pointer to a variable to fill with the status of the specified lighting parameters. After the call, a nonzero value at this address indicates that the specified lighting parameters are enabled; a value of 0 indicates that they are disabled. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the current material properties for the device. + Pointer to a D3DMATERIAL9 structure to fill with the currently set material properties. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL if the pMaterial parameter is invalid. + + + Gets the N-patch mode segments. + Specifies the number of subdivision segments. If the number of segments is less than 1.0, N-patches are disabled. The default value is 0.0. + + + Gets the number of implicit swap chains. + Number of implicit swap chains. See Remarks. + + + Retrieves palette entries. + An ordinal value identifying the particular palette to retrieve. + Pointer to a structure, representing the returned palette entries. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the currently set pixel shader. + Pointer to a pixel shader interface. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets a Boolean shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of Boolean values in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets a floating-point shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of four float vectors in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets an integer shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of four integer vectors in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Returns information describing the raster of the monitor on which the swap chain is presented. + An unsigned integer specifying the swap chain. + Pointer to a D3DRASTER_STATUS structure filled with information about the position or other status of the raster on the monitor driven by this adapter. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if pRasterStatus is invalid or if the device does not support reading the current scan line. To determine if the device supports reading the scan line, check for the D3DCAPS_READ_SCANLINE flag in the Caps member of . + + + Retrieves a render-state value for a device. + Device state variable that is being queried. This parameter can be any member of the D3DRENDERSTATETYPE enumerated type. + Pointer to a variable that receives the value of the queried render state variable when the method returns. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL if one of the arguments is invalid. + + + Retrieves a render-target surface. + Index of the render target. See Remarks. + Address of a pointer to an interface, representing the returned render-target surface for this device. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL if one of the arguments is invalid, or D3DERR_NOTFOUND if there's no render target available for the given index. + + + Copies the render-target data from device memory to system memory. + Pointer to an object, representing a render target. + Pointer to an object, representing a destination surface. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_DRIVERINTERNALERROR, D3DERR_DEVICELOST, D3DERR_INVALIDCALL. + + + Gets the sampler state value. + The sampler stage index. + This parameter can be any member of the D3DSAMPLERSTATETYPE enumerated type. + State value to get. The meaning of this value is determined by the Type parameter. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets the scissor rectangle. + Returns a pointer to a structure that defines the rendering area within the render target if scissor test is enabled. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be the following: D3DERR_INVALIDCALL. + + + Gets the vertex processing (hardware or software) mode. + Returns TRUE if software vertex processing is set. Otherwise, it returns FALSE. + + + Retrieves a vertex buffer bound to the specified data stream. + Specifies the data stream, in the range from 0 to the maximum number of streams minus one. + Address of a pointer to an interface, representing the returned vertex buffer bound to the specified data stream. + Pointer containing the offset from the beginning of the stream to the beginning of the vertex data. The offset is measured in bytes. See Remarks. + Pointer to a returned stride of the component, in bytes. See Remarks. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets the stream source frequency divider value. + + Stream source number. +

- Divider

+ Returns the frequency divider value. + + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets a pointer to a swap chain. + The swap chain ordinal value. For more information, see NumberOfAdaptersInGroup in . + Pointer to an interface that will receive a copy of swap chain. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL. + + + Retrieves a texture assigned to a stage for a device. + Stage identifier of the texture to retrieve. Stage identifiers are zero-based. + Address of a pointer to an interface, representing the returned texture. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves a state value for an assigned texture. + Stage identifier of the texture for which the state is retrieved. Stage identifiers are zero-based. Devices can have up to eight set textures, so the maximum value allowed for Stage is 7. + Texture state to retrieve. This parameter can be any member of the D3DTEXTURESTAGESTATETYPE enumerated type. + Pointer a variable to fill with the retrieved state value. The meaning of the retrieved value is determined by the Type parameter. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves a matrix describing a transformation state. + Device state variable that is being modified. This parameter can be any member of the D3DTRANSFORMSTATETYPE enumerated type, or the D3DTS_WORLDMATRIX macro. + Pointer to aD3DMATRIX structure, describing the returned transformation state. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL if one of the arguments is invalid. + + + Gets a vertex shader declaration. + Pointer to an object that is returned. + If the method succeeds, the return value is D3D_OK. The return value can be D3DERR_INVALIDCALL. + + + Retrieves the currently set vertex shader. + Pointer to a vertex shader interface. + If the method succeeds, the return value is D3D_OK. If ppShader is invalid, D3DERR_INVALIDCALL is returned. + + + Gets a Boolean vertex shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of Boolean values in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets a floating-point vertex shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of four float vectors in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets an integer vertex shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of four integer vectors in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the viewport parameters currently set for the device. + Pointer to a D3DVIEWPORT9 structure, representing the returned viewport parameters. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if the pViewport parameter is invalid. + + + Enables or disables a set of lighting parameters within a device. + Zero-based index of the set of lighting parameters that are the target of this method. + Value that indicates if the set of lighting parameters are being enabled or disabled. Set this parameter to TRUE to enable lighting with the parameters at the specified index, or FALSE to disable it. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Multiplies a device's world, view, or projection matrices by a specified matrix. + Member of the D3DTRANSFORMSTATETYPE enumerated type, or the D3DTS_WORLDMATRIX macro that identifies which device matrix is to be modified. The most common setting, D3DTS_WORLDMATRIX(0), modifies the world matrix, but you can specify that the method modify the view or projection matrices, if needed. + Pointer to a D3DMATRIX structure that modifies the current transformation. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL if one of the arguments is invalid. + + + Presents the contents of the next buffer in the sequence of back buffers owned by the device. + Pointer to a value that must be NULL unless the swap chain was created with D3DSWAPEFFECT_COPY. pSourceRect is a pointer to a structure containing the source rectangle. If NULL, the entire source surface is presented. If the rectangle exceeds the source surface, the rectangle is clipped to the source surface. + Pointer to a value that must be NULL unless the swap chain was created with D3DSWAPEFFECT_COPY. pDestRect is a pointer to a structure containing the destination rectangle, in window client coordinates. If NULL, the entire client area is filled. If the rectangle exceeds the destination client area, the rectangle is clipped to the destination client area. + Pointer to a destination window whose client area is taken as the target for this presentation. If this value is NULL, the runtime uses the hDeviceWindow member of D3DPRESENT_PARAMETERS for the presentation. + Value must be NULL unless the swap chain was created with D3DSWAPEFFECT_COPY. For more information about swap chains, see Flipping Surfaces (Direct3D 9) and D3DSWAPEFFECT. If this value is non-NULL, the contained region is expressed in back buffer coordinates. The rectangles within the region are the minimal set of pixels that need to be updated. This method takes these rectangles into account when optimizing the presentation by copying only the pixels within the region, or some suitably expanded set of rectangles. This is an aid to optimization only, and the application should not rely on the region being copied exactly. The implementation can choose to copy the whole source rectangle. + Possible return values include: D3D_OK or D3DERR_DEVICEREMOVED (see D3DERR). + + + Applies the vertex processing defined by the vertex shader to the set of input data streams, generating a single stream of interleaved vertex data to the destination vertex buffer. + Index of first vertex to load. + Index of first vertex in the destination vertex buffer into which the results are placed. + Number of vertices to process. + Pointer to an interface, the destination vertex buffer representing the stream of interleaved vertex data. + Pointer to an interface that represents the output vertex data declaration. When vertex shader 3.0 or above is set as the current vertex shader, the output vertex declaration must be present. + Processing options. Set this parameter to 0 for default processing. Set to D3DPV_DONOTCOPYDATA to prevent the system from copying vertex data not affected by the vertex operation into the destination buffer. The D3DPV_DONOTCOPYDATA value may be combined with one or more D3DLOCK values appropriate for the destination buffer. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Resets the type, size, and format of the swap chain. + + Pointer to a D3DPRESENT_PARAMETERS structure, describing the new presentation parameters. This value cannot be NULL. + When switching to full-screen mode, Direct3D will try to find a desktop format that matches the back buffer format, so that back buffer and front buffer formats will be identical (to eliminate the need for color conversion). + When this method returns: + + + BackBufferCount, BackBufferWidth, and BackBufferHeight are set to zero. + + + BackBufferFormat is set to D3DFMT_UNKNOWN for windowed mode only; a full-screen mode must specify a format. + + + + Possible return values include: D3D_OK, D3DERR_DEVICELOST, D3DERR_DEVICEREMOVED, D3DERR_DRIVERINTERNALERROR, or D3DERR_OUTOFVIDEOMEMORY (see D3DERR). + + + Sets the coefficients of a user-defined clipping plane for the device. + Index of the clipping plane for which the plane equation coefficients are to be set. + Pointer to an address of a four-element array of values that represent the clipping plane coefficients to be set, in the form of the general plane equation. See Remarks. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value is D3DERR_INVALIDCALL. This error indicates that the value in Index exceeds the maximum clipping plane index supported by the device or that the array at pPlane is not large enough to contain four floating-point values. + + + Sets the clip status. + Pointer to a D3DCLIPSTATUS9 structure, describing the clip status settings to be set. + If the method succeeds, the return value is D3D_OK. If one of the arguments is invalid, the return value is D3DERR_INVALIDCALL. + + + Sets the current texture palette. + Value that specifies the texture palette to set as the current texture palette. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the cursor position and update options. + The new X-position of the cursor in virtual desktop coordinates. See Remarks. + The new Y-position of the cursor in virtual desktop coordinates. See Remarks. + + Specifies the update options for the cursor. Currently, only one flag is defined. + + + Value + Meaning + + + + + + + D3DCURSOR_IMMEDIATE_UPDATE + + + + + Update cursor at the refresh rate.If this flag is specified, the system guarantees that the cursor will be updated at a minimum of half the display refresh rate, but never more frequently than the display refresh rate. Otherwise, the method delays cursor updates until the next call. Not setting this flag usually results in better performance than if the flag is set. However, applications should set this flag if the rate of calls to Present is low enough that users would notice a significant delay in cursor motion. This flag has no effect in a windowed-mode application. Some video cards implement hardware color cursors. This flag does not have an effect on these cards. + + + + + + Sets properties for the cursor. + X-coordinate offset (in pixels) that marks the center of the cursor. The offset is relative to the upper-left corner of the cursor. When the cursor is given a new position, the image is drawn at an offset from this new position determined by subtracting the hot spot coordinates from the position. + Y-coordinate offset (in pixels) that marks the center of the cursor. The offset is relative to the upper-left corner of the cursor. When the cursor is given a new position, the image is drawn at an offset from this new position determined by subtracting the hot spot coordinates from the position. + Pointer to an interface. This parameter must point to an 8888 ARGB surface (format D3DFMT_A8R8G8B8). The contents of this surface will be copied and potentially format-converted into an internal buffer from which the cursor is displayed. The dimensions of this surface must be less than the dimensions of the display mode, and must be a power of two in each direction, although not necessarily the same power of two. The alpha channel must be either 0.0 or 1.0. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the depth stencil surface. + Address of a pointer to an interface representing the depth stencil surface. Setting this to NULL disables the depth stencil operation. + If the method succeeds, the return value is D3D_OK. If pZStencilSurface is other than NULL, the return value is D3DERR_INVALIDCALL when the stencil surface is invalid. + + + This method allows the use of GDI dialog boxes in full-screen mode applications. + + TRUE to enable GDI dialog boxes, and FALSE to disable them. + + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL unless all of the following are true. + + + The application specified a back buffer format compatible with GDI, in other words, one of D3DFMT_X1R5G5B5, D3DFMT_R5G6B5, or D3DFMT_X8R8G8B8. + + + The application specified no multisampling. + + + The application specified D3DSWAPEFFECT_DISCARD. + + + The application specified D3DPRESENTFLAG_LOCKABLE_BACKBUFFER. + + + The application did not specify D3DCREATE_ADAPTERGROUP_DEVICE. + + + The application is not between BeginScene and EndScene. + + + + + + Sets the current vertex stream declaration. + DWORD containing the fixed function vertex type. For more information, see D3DFVF. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Sets the gamma correction ramp for the implicit swap chain. This method will affect the entire screen (not just the active window if you are running in windowed mode). + Unsigned integer specifying the swap chain. + + Indicates whether correction should be applied. Gamma correction results in a more consistent display, but can incur processing overhead and should not be used frequently. Short-duration effects, such as flashing the whole screen red, should not be calibrated, but long-duration gamma changes should be calibrated. One of the following values can be set: + + + Item + Description + + + D3DSGR_CALIBRATE + If a gamma calibrator is installed, the ramp will be modified before being sent to the device to account for the system and monitor response curves. If a calibrator is not installed, the ramp will be passed directly to the device. + + + D3DSGR_NO_CALIBRATION + No gamma correction is applied. The supplied gamma table is transferred directly to the device. + + + + Pointer to a D3DGAMMARAMP structure, representing the gamma correction ramp to be set for the implicit swap chain. + + + Sets index data. + Pointer to an interface, representing the index data to be set. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Assigns a set of lighting properties for this device. + Zero-based index of the set of lighting properties to set. If a set of lighting properties exists at this index, it is overwritten by the new properties specified in pLight. + Pointer to a D3DLIGHT9 structure, containing the lighting parameters to set. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the material properties for the device. + Pointer to a D3DMATERIAL9 structure, describing the material properties to set. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL if the pMaterial parameter is invalid. + + + Enable or disable N-patches. + Specifies the number of subdivision segments. If the number of segments is less than 1.0, N-patches are disabled. The default value is 0.0. + If the method succeeds, the return value is D3D_OK. + + + Sets palette entries. + An ordinal value identifying the particular palette upon which the operation is to be performed. + Pointer to a structure, representing the palette entries to set. The number of PALETTEENTRY structures pointed to by pEntries is assumed to be 256. See Remarks. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the current pixel shader to a previously created pixel shader. + Pixel shader interface. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets a Boolean shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of boolean values in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets a floating-point shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of four float vectors in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets an integer shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of four integer vectors in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets a single device render-state parameter. + Device state variable that is being modified. This parameter can be any member of the D3DRENDERSTATETYPE enumerated type. + New value for the device render state to be set. The meaning of this parameter is dependent on the value specified for State. For example, if State were D3DRS_SHADEMODE, the second parameter would be one member of the D3DSHADEMODE enumerated type. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if one of the arguments is invalid. + + + Sets a new color buffer for the device. + Index of the render target. See Remarks. + Pointer to a new color buffer. If NULL, the color buffer for the corresponding RenderTargetIndex is disabled. Devices always must be associated with a color buffer. The new render-target surface must have at least D3DUSAGE_RENDERTARGET specified. + + If the method succeeds, the return value is D3D_OK. This method will return D3DERR_INVALIDCALL if either: + + + pRenderTarget = NULL and RenderTargetIndex = 0 + + + pRenderTarget is != NULL and the render target is invalid. + + + + + + Sets the sampler state value. + The sampler stage index. For more info about sampler stage, see Sampling Stage Registers in vs_3_0 (DirectX HLSL). + This parameter can be any member of the D3DSAMPLERSTATETYPE enumerated type. + State value to set. The meaning of this value is determined by the Type parameter. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the scissor rectangle. + Pointer to a structure that defines the rendering area within the render target if scissor test is enabled. This parameter may not be NULL. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Use this method to switch between software and hardware vertex processing. + + TRUE to specify software vertex processing; FALSE to specify hardware vertex processing. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Binds a vertex buffer to a device data stream. For more information, see Setting the Stream Source (Direct3D 9). + Specifies the data stream, in the range from 0 to the maximum number of streams -1. + Pointer to an interface, representing the vertex buffer to bind to the specified data stream. + Offset from the beginning of the stream to the beginning of the vertex data, in bytes. To find out if the device supports stream offsets, see the D3DDEVCAPS2_STREAMOFFSET constant in D3DDEVCAPS2. + Stride of the component, in bytes. See Remarks. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the stream source frequency divider value. This may be used to draw several instances of geometry. + Stream source number. + This parameter may have two different values. See remarks. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Assigns a texture to a stage for a device. + + Zero based sampler number. Textures are bound to samplers; samplers define sampling state such as the filtering mode and the address wrapping mode. Textures are referenced differently by the programmable and the fixed function pipeline: + + + Programmable shaders reference textures using the sampler number. The number of samplers available to a programmable shader is dependent on the shader version. For vertex shaders, see Sampler (Direct3D 9 asm-vs). For pixel shaders see Sampler (Direct3D 9 asm-ps). + + + The fixed function pipeline on the other hand, references textures by texture stage number. The maximum number of samplers is determined from two caps: MaxSimultaneousTextures and MaxTextureBlendStages of the structure. + + There are two other special cases for stage/sampler numbers.A special number called D3DDMAPSAMPLER is used for Displacement Mapping (Direct3D 9).A programmable vertex shader uses a special number defined by a D3DVERTEXTEXTURESAMPLER when accessing Vertex Textures in vs_3_0 (DirectX HLSL). + Pointer to an interface, representing the texture being set. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the state value for the currently assigned texture. + Stage identifier of the texture for which the state value is set. Stage identifiers are zero-based. Devices can have up to eight set textures, so the maximum value allowed for Stage is 7. + Texture state to set. This parameter can be any member of the D3DTEXTURESTAGESTATETYPE enumerated type. + State value to set. The meaning of this value is determined by the Type parameter. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets a single device transformation-related state. + Device-state variable that is being modified. This parameter can be any member of the D3DTRANSFORMSTATETYPE enumerated type, or the D3DTS_WORLDMATRIX macro. + Pointer to a D3DMATRIX structure that modifies the current transformation. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if one of the arguments is invalid. + + + Sets a Vertex Declaration (Direct3D 9). + Pointer to an object, which contains the vertex declaration. + If the method succeeds, the return value is D3D_OK. The return value can be D3DERR_INVALIDCALL. + + + Sets the vertex shader. + Vertex shader interface. For more information, see . + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets a Boolean vertex shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of boolean values in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets a floating-point vertex shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of four float vectors in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets an integer vertex shader constant. + Register number that will contain the first constant value. + Pointer to an array of constants. + Number of four integer vectors in the array of constants. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Sets the viewport parameters for the device. + Pointer to a D3DVIEWPORT9 structure, specifying the viewport parameters to set. + If the method succeeds, the return value is D3D_OK. If the method fails, it will return D3DERR_INVALIDCALL. This will happen if pViewport is invalid, or if pViewport describes a region that cannot exist within the render target surface. + + + Displays or hides the cursor. + If bShow is TRUE, the cursor is shown. If bShow is FALSE, the cursor is hidden. + Value indicating whether the cursor was previously visible. TRUE if the cursor was previously visible, or FALSE if the cursor was not previously visible. + + + Copy the contents of the source rectangle to the destination rectangle. The source rectangle can be stretched and filtered by the copy. This function is often used to change the aspect ratio of a video stream. + Pointer to the source surface. See . + Pointer to the source rectangle. A NULL for this parameter causes the entire source surface to be used. + Pointer to the destination surface. See . + Pointer to the destination rectangle. A NULL for this parameter causes the entire destination surface to be used. + Filter type. Allowable values are D3DTEXF_NONE, D3DTEXF_POINT, or D3DTEXF_LINEAR. For more information, see D3DTEXTUREFILTERTYPE. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Reports the current cooperative-level status of the Direct3D device for a windowed or full-screen application. + If the method succeeds, the return value is D3D_OK, indicating that the device is operational and the calling application can continue. If the method fails, the return value can be one of the following values: D3DERR_DEVICELOST, D3DERR_DEVICENOTRESET, D3DERR_DRIVERINTERNALERROR. + + + Copies rectangular subsets of pixels from one surface to another. + Pointer to an interface, representing the source surface. This parameter must point to a different surface than pDestinationSurface. + Pointer to a rectangle on the source surface. Specifying NULL for this parameter causes the entire surface to be copied. + Pointer to an interface, representing the destination surface. + Pointer to the upper left corner of the destination rectangle. Specifying NULL for this parameter causes the entire surface to be copied. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL. + + + Updates the dirty portions of a texture. + Pointer to an interface, representing the source texture. The source texture must be in system memory (D3DPOOL_SYSTEMMEM). + Pointer to an interface, representing the destination texture. The destination texture must be in the D3DPOOL_DEFAULT memory pool. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Reports the device's ability to render the current texture-blending operations and arguments in a single pass. + Pointer to a DWORD value to fill with the number of rendering passes needed to complete the desired effect through multipass rendering. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_CONFLICTINGRENDERSTATE, D3DERR_CONFLICTINGTEXTUREFILTER, D3DERR_DEVICELOST, D3DERR_DRIVERINTERNALERROR, D3DERR_TOOMANYOPERATIONS, D3DERR_UNSUPPORTEDALPHAARG, D3DERR_UNSUPPORTEDALPHAOPERATION, D3DERR_UNSUPPORTEDCOLORARG, D3DERR_UNSUPPORTEDCOLOROPERATION, D3DERR_UNSUPPORTEDFACTORVALUE, D3DERR_UNSUPPORTEDTEXTUREFILTER, D3DERR_WRONGTEXTUREFORMAT,. + + + Applications use the methods of the IDirect3DDevice9 interface to perform DrawPrimitive-based rendering, create resources, work with system-level variables, adjust gamma ramp levels, work with palettes, and create shaders. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9Ex.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9Ex.xml new file mode 100644 index 0000000000..ea293a3b20 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9Ex.xml @@ -0,0 +1,181 @@ + + + + + + Reports the current cooperative-level status of the Direct3D device for a windowed or full-screen application. + The destination window handle to check for occlusion. When this parameter is NULL, S_PRESENT_OCCLUDED is returned when another device has fullscreen ownership. When the window handle is not NULL, window's client area is checked for occlusion. A window is occluded if any part of it is obscured by another application. + Possible return values include: D3D_OK, D3DERR_DEVICELOST, D3DERR_DEVICEHUNG, D3DERR_DEVICEREMOVED, or D3DERR_OUTOFVIDEOMEMORY (see D3DERR), or S_PRESENT_MODE_CHANGED, or S_PRESENT_OCCLUDED (see S_PRESENT). + + + Checks an array of resources to determine if it is likely that they will cause a large stall at Draw time because the system must make the resources GPU-accessible. + An array of pointers that indicate the resources to check. + A value indicating the number of resources passed into the pResourceArray parameter up to a maximum of 65535. + + If all the resources are in GPU-accessible memory, the method will return S_OK. The system may need to perform a remapping operation to promote the resources, but will not have to copy data. + If no allocation that comprises the resources is on disk, but at least one allocation is not in GPU-accessible memory, the method will return S_RESIDENT_IN_SHARED_MEMORY. The system may need to perform a copy to promote the resource. + If at least one allocation that comprises the resources is on disk, this method will return S_NOT_RESIDENT. The system may need to perform a copy to promote the resource. + + + + Copy a text string to one surface using an alphabet of glyphs on another surface. Composition is done by the GPU using bitwise operations. + A pointer to a source surface (prepared by ) that supplies the alphabet glyphs. This surface must be created with the D3DUSAGE_TEXTAPI flag. + A pointer to the destination surface (prepared by ) that receives the glyph data. The surface must be part of a texture. + A pointer to a vertex buffer (see ) containing rectangles (see D3DCOMPOSERECTDESC) that enclose the desired glyphs in the source surface. + The number of rectangles or glyphs that are used in the operation. The number applies to both the source and destination surfaces. The range is 0 to D3DCOMPOSERECTS_MAXNUMRECTS. + A pointer to a vertex buffer (see ) containing rectangles (see D3DCOMPOSERECTDESTINATION) that describe the destination to which the indicated glyph from the source surface will be copied. + Specifies how to combine the source and destination surfaces. See D3DCOMPOSERECTSOP. + A value added to the x coordinates of all destination rectangles. This value can be negative, which may cause the glyph to be rejected or clipped if the result is beyond the bounds of the surface. + A value added to the y coordinates of all destination rectangles. This value can be negative, which may cause the glyph to be rejected or clipped if the result is beyond the bounds of the surface. + If the method succeeds, the return value is D3D_OK. + + + Creates a depth-stencil surface. + Width of the depth-stencil surface, in pixels. + Height of the depth-stencil surface, in pixels. + Member of the D3DFORMAT enumerated type, describing the format of the depth-stencil surface. This value must be one of the enumerated depth-stencil formats for this device. + Member of the D3DMULTISAMPLE_TYPE enumerated type, describing the multisampling buffer type. This value must be one of the allowed multisample types. When this surface is passed to , its multisample type must be the same as that of the render target set by . + Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by . Passing a larger value returns the error D3DERR_INVALIDCALL. The MultisampleQuality values of paired render targets, depth stencil surfaces, and the MultiSample type must all match. + + Set this flag to TRUE to enable z-buffer discarding, and FALSE otherwise. If this flag is set, the contents of the depth stencil buffer will be invalid after calling either or with a different depth surface. + This flag has the same behavior as the constant, D3DPRESENTFLAG_DISCARD_DEPTHSTENCIL, in D3DPRESENTFLAG. + + Address of a pointer to an interface, representing the created depth-stencil surface resource. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + Combination of one or more D3DUSAGE constants which can be OR'd together. Value of 0 indicates no usage. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_NOTAVAILABLE, D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Create an off-screen surface. + Width of the surface. + Height of the surface. + Format of the surface. See D3DFORMAT. + Surface pool type. See D3DPOOL. + Pointer to the interface created. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + Combination of one or more D3DUSAGE constants which can be OR'd together. Value of 0 indicates no usage. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be the following: D3DERR_INVALIDCALL. + + + Creates a render-target surface. + Width of the render-target surface, in pixels. + Height of the render-target surface, in pixels. + Member of the D3DFORMAT enumerated type, describing the format of the render target. + Member of the D3DMULTISAMPLE_TYPE enumerated type, which describes the multisampling buffer type. This parameter specifies the antialiasing type for this render target. When this surface is passed to , its multisample type must be the same as that of the depth-stencil set by . + Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by . Passing a larger value returns the error, D3DERR_INVALIDCALL. The MultisampleQuality values of paired render targets, depth stencil surfaces, and the multisample type must all match. + + Render targets are not lockable unless the application specifies TRUE for Lockable. + Note that lockable render targets reduce performance on some graphics hardware. The readback performance (moving data from video memory to system memory) depends on the type of hardware used (AGP vs. PCI Express) and is usually far lower than upload performance (moving data from system to video memory). If you need read access to render targets, use instead of lockable render targets. + + Address of a pointer to an interface. + Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources. + Combination of one or more D3DUSAGE constants which can be OR'd together. Value of 0 indicates no usage. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_NOTAVAILABLE, D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Retrieves the display mode's spatial resolution, color resolution, refresh frequency, and rotation settings. + An unsigned integer specifying the swap chain. + Pointer to a D3DDISPLAYMODEEX structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode. Can be set to NULL. + Pointer to a D3DDISPLAYROTATION indicating the type of screen rotation the application will do. The value returned through this pointer is important when the D3DPRESENTFLAG_NOAUTOROTATE flag is used; otherwise, it can be set to NULL. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Get the priority of the GPU thread. + Current GPU priority. Valid values range from -7 to 7. + Possible return values include: D3D_OK or D3DERR_DEVICEREMOVED (see D3DERR). + + + Retrieves the number of frames of data that the system is allowed to queue. + Returns the number of frames that can be queued for render. The value is typically 3, but can range from 1 to 20. + Possible return values include: D3D_OK, D3DERR_DEVICELOST, D3DERR_DEVICEREMOVED, D3DERR_DRIVERINTERNALERROR, D3DERR_INVALIDCALL, or D3DERR_OUTOFVIDEOMEMORY (see D3DERR). + + + Swap the swapchain's next buffer with the front buffer. + Pointer to a structure indicating region on the source surface to copy in window client coordinates. Only applies when the swapchain was created with the D3DSWAPEFFECT_COPY flag. If NULL, the entire source surface is presented. If the rectangle exceeds the source surface, it is clipped to the source surface. + Pointer to structure indicating the target region on the destination surface in window client coordinates. Only applies when the swapchain was created with the D3DSWAPEFFECT_COPY flag. If NULL, the entire client area is filled. If the rectangle exceeds the destination client area, it is clipped to the destination client area. + + Pointer to a destination window whose client area is taken as the target for this presentation. If this value is NULL, the runtime uses the hDeviceWindow member of D3DPRESENT_PARAMETERS for the presentation. +
+ Note  If you create a swap chain with D3DSWAPEFFECT_FLIPEX, you must pass NULL to hDestWindowOverride
+ + + Pointer to a structure indicating the smallest set of pixels that need to be transferred. This value must be NULL unless the swapchain was created with the D3DSWAPEFFECT_COPY flag. For more information about swapchains, see Flipping Surfaces (Direct3D 9). + If this value is non-NULL, the contained region is expressed in back buffer coordinates. The method takes these rectangles into account when optimizing the presentation by copying only the pixels within the region, or some suitably expanded set of rectangles. This is an aid to optimization only, and the application should not rely on the region being copied exactly. The implementation can choose to copy the whole source rectangle. + + + Allows the application to request that the method return immediately when the driver reports that it cannot schedule a presentation. Valid values are 0, or any combination of D3DPRESENT flags. + + + If dwFlags = 0, this method behaves as it did prior to Direct3D 9. Present will spin until the hardware is free, without returning an error. + + + If dwFlags = D3DPRESENT_DONOTFLIP the display driver is called with the front buffer as both the source and target surface. The driver responds by scheduling a frame synch, but not changing the displayed surface. This flag is only available in full-screen mode or when using D3DSWAPEFFECT_FLIPEX in windowed mode. + + + If dwFlags = D3DPRESENT_DONOTWAIT, and the hardware is busy processing or waiting for a vertical sync interval, the method will return D3DERR_WASSTILLDRAWING. + + + If dwFlags = D3DPRESENT_FORCEIMMEDIATE, D3DPRESENT_INTERVAL_IMMEDIATE is enforced on this Present call. This flag can only be specified when using D3DSWAPEFFECT_FLIPEX. This behavior is the same for windowed and full-screen modes. + + + If dwFlags = D3DPRESENT_LINEAR_CONTENT, gamma correction is performed from linear space to sRGB for windowed swap chains. This flag will take effect only when the driver exposes D3DCAPS3_LINEAR_TO_SRGB_PRESENTATION (see Gamma (Direct3D 9)). + + + + + Possible return values include: S_OK, D3DERR_DEVICELOST, D3DERR_DEVICEHUNG, D3DERR_DEVICEREMOVED, or D3DERR_OUTOFVIDEOMEMORY (see D3DERR). See Lost Device Behavior Changes for more information about lost, hung, and removed devices. + + + Differences between Direct3D 9 and Direct3D 9Ex:D3DSWAPEFFECT_FLIPEX is only available in Direct3D9Ex running on Windows 7 (or more current operating system). + + + + + + Resets the type, size, and format of the swap chain with all other surfaces persistent. + + Pointer to a D3DPRESENT_PARAMETERS structure, describing the new presentation parameters. This value cannot be NULL. + When switching to full-screen mode, Direct3D will try to find a desktop format that matches the back buffer format, so that back buffer and front buffer formats will be identical (to eliminate the need for color conversion). + When this method returns: + + + BackBufferCount, BackBufferWidth, and BackBufferHeight are set to zero. + + + BackBufferFormat is set to D3DFORMAT for windowed mode only; a full-screen mode must specify a format. + + + + Pointer to a D3DDISPLAYMODEEX structure that describes the properties of the desired display mode. This value must be provided for fullscreen applications, but can be NULL for windowed applications. + + The method can return: D3D_OK, D3DERR_DEVICELOST or D3DERR_DEVICEHUNG (see D3DERR). + If this method returns D3DERR_DEVICELOST or D3DERR_DEVICEHUNG then the application can only call IDirect3DDevice9Ex.ResetEx, or release the interface pointer; any other API call will cause an exception. + + + + Prepare the texture sampler for monochrome convolution filtering on a single-color texture. + The width of the filter kernel; ranging from 1 - D3DCONVOLUTIONMONO_MAXWIDTH. The default value is 1. + The height of the filter kernel; ranging from 1 - D3DCONVOLUTIONMONO_MAXHEIGHT. The default value is 1. + An array of weights, one weight for each kernel sub-element in the width. This parameter must be NULL, which will set the weights equal to the default value. + An array of weights, one weight for each kernel sub-element in the height. This parameter must be NULL, which will set the weights equal to the default value. + If the method succeeds, the return value is D3D_OK. + + + Set the priority on the GPU thread. + The thread priority, ranging from -7 to 7. + Possible return values include: D3D_OK, D3DERR_INVALIDCALL, or D3DERR_DEVICEREMOVED (see D3DERR). + + + Set the number of frames that the system is allowed to queue for rendering. + The maximum number of back buffer frames that a driver can queue. The value is typically 3, but can range from 1 to 20. A value of 0 will reset latency to the default. For multi-head devices, MaxLatency is specified per-head. + Possible return values include: D3D_OK or D3DERR_DEVICEREMOVED (see D3DERR). + + + Suspend execution of the calling thread until the next vertical blank signal. + Swap chain index. This is an optional, zero-based index used to specify a swap chain on a multihead card. + This method will always return D3D_OK. + + + Applications use the methods of the IDirect3DDevice9Ex interface to render primitives, create resources, work with system-level variables, adjust gamma ramp levels, work with palettes, and create shaders. The IDirect3DDevice9Ex interface derives from the interface. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9Video.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9Video.xml new file mode 100644 index 0000000000..8dc4ec2107 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DDevice9Video.xml @@ -0,0 +1,53 @@ + + + + + + Creates a channel to communicate with the Direct3D device or the graphics driver. + Specifies the type of channel, as a member of the D3DAUTHENTICATEDCHANNELTYPE enumeration. + Receives a pointer to the interface. The caller must release the interface. + Receives a pointer to a handle for the channel. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a cryptographic session to encrypt video content that is sent to the display driver. + + Pointer to a GUID that specifies the type of encryption to use. The following GUIDs are defined. + + pDecodeProfile + + A pointer to a GUID that specifies the DirectX Video Acceleration 2 (DXVA-2) decoding profile. For a list of possible values, see IDirectXVideoDecoderService.GetDecoderDeviceGuids. If DXVA-2 decoding will not be used, set this parameter to NULL. + + pCaps + + A pointer to a D3DCONTENTPROTECTIONCAPS structure. The method fills in this structure with the driver's content protection capabilities. + + Pointer to a GUID that specifies the DirectX Video Acceleration 2 (DXVA-2) decoding profile. For a list of possible values, see . If DXVA-2 decoding will not be used, set this parameter to NULL. + Receives a pointer to the interface. The caller must release the interface. + Receives a handle for the session. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Queries the display driver for its content protection capabilities. + + A pointer to a GUID that specifies the type of encryption to use. The following GUIDs are defined. + + D3DCRYPTOTYPE_AES128_CTR + + 128-bit Advanced Encryption Standard CTR mode (AES-CTR) block cipher. + + D3DCRYPTOTYPE_PROPRIETARY + + Proprietary encryption algorithm. + + A pointer to a GUID that specifies the DirectX Video Acceleration 2 (DXVA-2) decoding profile. For a list of possible values, see . If DXVA-2 decoding will not be used, set this parameter to NULL. + A pointer to a structure. The method fills in this structure with the driver's content protection capabilities. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + + Enables an application to use content protection and encryption services implemented by a graphics driver. + To get a pointer to this interface, call QueryInterface on a D3D9Ex device. + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DIndexBuffer9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DIndexBuffer9.xml new file mode 100644 index 0000000000..6f16c728b1 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DIndexBuffer9.xml @@ -0,0 +1,43 @@ + + + + + + Retrieves a description of the index buffer resource. + Pointer to a D3DINDEXBUFFER_DESC structure, describing the returned index buffer. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if the argument is invalid. + + + Locks a range of index data and obtains a pointer to the index buffer memory. + Offset into the index data to lock, in bytes. Lock the entire index buffer by specifying 0 for both parameters, SizeToLock and OffsetToLock. + Size of the index data to lock, in bytes. Lock the entire index buffer by specifying 0 for both parameters, SizeToLock and OffsetToLock. + VOID* pointer to a memory buffer containing the returned index data. + + Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are: + + + D3DLOCK_DISCARD + + + D3DLOCK_NO_DIRTY_UPDATE + + + D3DLOCK_NOSYSLOCK + + + D3DLOCK_READONLY + + + D3DLOCK_NOOVERWRITE + + For a description of the flags, see D3DLOCK. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Unlocks index data. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DIndexBuffer9 interface to manipulate an index buffer resource. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DPixelShader9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DPixelShader9.xml new file mode 100644 index 0000000000..baf2861051 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DPixelShader9.xml @@ -0,0 +1,19 @@ + + + + + + Gets the device. + Pointer to the IDirect3DDevice9 interface that is returned. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets a pointer to the shader data. + Pointer to a buffer that contains the shader data. The application needs to allocate enough room for this. + Size of the data, in bytes. To get the buffer size that is needed to retrieve the data, set pData = NULL when calling GetFunction. Then call GetFunction with the returned size, to get the buffer data. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DPixelShader9 interface to encapsulate the functionality of a pixel shader. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DQuery9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DQuery9.xml new file mode 100644 index 0000000000..b4dda2c5e2 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DQuery9.xml @@ -0,0 +1,33 @@ + + + + + + Polls a queried resource to get the query state or a query result. For more information about queries, see Queries (Direct3D 9). + Pointer to a buffer containing the query data. The user is responsible for allocating this. pData may be NULL only if dwSize is 0. + Number of bytes of data in pData. If you set dwSize to zero, you can use this method to poll the resource for the query status. See remarks. + Data flags specifying the query type. Valid values are either 0 or D3DGETDATA_FLUSH. Use 0 to avoid flushing batched queries to the driver and use D3DGETDATA_FLUSH to go ahead and flush them. For applications writing their own version of waiting, a query result is not realized until the driver receives a flush. + The return type identifies the query state (see Queries (Direct3D 9)). The method returns S_OK if the query data is available and S_FALSE if it is not. These are considered successful return values. If the method fails when D3DGETDATA_FLUSH is used, the return value can be D3DERR_DEVICELOST. + + + Gets the number of bytes in the query data. + Returns the number of bytes of query data. + + + Gets the device that is being queried. + Pointer to the device being queried. See . + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets the query type. + Returns the query type. See D3DQUERYTYPE. + + + Issue a query. + Query flags specify the type of state change for the query. See D3DISSUE_BEGIN and D3DISSUE_END. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DQuery9 interface to perform asynchronous queries on a driver. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DResource9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DResource9.xml new file mode 100644 index 0000000000..854bcb36db --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DResource9.xml @@ -0,0 +1,72 @@ + + + + + + Frees the specified private data associated with this resource. + Reference to the globally unique identifier that identifies the private data to free. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_NOTFOUND. + + + Retrieves the device associated with a resource. + Address of a pointer to an interface to fill with the device pointer, if the query succeeds. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the priority for this resource. + Returns a DWORD value, indicating the priority of the resource. + + + Copies the private data associated with the resource to a provided buffer. + The globally unique identifier that identifies the private data to retrieve. + Pointer to a previously allocated buffer to fill with the requested private data if the call succeeds. The application calling this method is responsible for allocating and releasing this buffer. If this parameter is NULL, this method will return the buffer size in pSizeOfData. + Pointer to the size of the buffer at pData, in bytes. If this value is less than the actual size of the private data (such as 0), the method sets this parameter to the required buffer size and the method returns D3DERR_MOREDATA. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_MOREDATA, D3DERR_NOTFOUND. + + + Returns the type of the resource. + Returns a member of the D3DRESOURCETYPE enumerated type, identifying the type of the resource. + + + Preloads a managed resource. + + + Assigns the priority of a resource for scheduling purposes. + + Priority to assign to a resource. + + + Differences between Direct3D 9 and Direct3D 9 for Windows VistaThe priority can be any DWORD value; Direct3D 9 for Windows Vista also supports any of these pre-defined values D3D9_RESOURCE_PRIORITY. + + + + Returns the previous priority value for the resource. + + + Associates data with the resource that is intended for use by the application, not by Direct3D. Data is passed by value, and multiple sets of data can be associated with a single resource. + Reference to the globally unique identifier that identifies the private data to set. + Pointer to a buffer that contains the data to be associated with the resource. + Size of the buffer at pData, in bytes. + + Value that describes the type of data being passed, or indicates to the application that the data should be invalidated when the resource changes. + + + Item + Description + + + (none) + If no flags are specified, Direct3D allocates memory to hold the data within the buffer and copies the data into the new buffer. The buffer allocated by Direct3D is automatically freed, as appropriate. + + + D3DSPD_IUNKNOWN + The data at pData is a pointer to an interface. SizeOfData must be set to the size of a pointer to IUnknown, that is, sizeof(IUnknown*). Direct3D automatically callsIUnknown through pData when the private data is destroyed. Private data will be destroyed by a subsequent call to IDirect3DResource9.SetPrivateData with the same GUID, a subsequent call to , or when the object is released. For more information, see Remarks. + + + + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, E_OUTOFMEMORY. + + + Applications use the methods of the IDirect3DResource9 interface to query and prepare resources. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DStateBlock9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DStateBlock9.xml new file mode 100644 index 0000000000..fba3c8329d --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DStateBlock9.xml @@ -0,0 +1,21 @@ + + + + + + Apply the state block to the current device state. + If the method succeeds, the return value is D3D_OK. If the method fails while in record mode, the return value is D3DERR_INVALIDCALL. + + + Capture the current value of states that are included in a stateblock. + If the method succeeds, the return value is D3D_OK. If the method fails because capture cannot be done while in record mode, the return value is D3DERR_INVALIDCALL. + + + Gets the device. + Pointer to the IDirect3DDevice9 interface that is returned. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DStateBlock9 interface to encapsulate render states. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSurface9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSurface9.xml new file mode 100644 index 0000000000..b743907288 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSurface9.xml @@ -0,0 +1,64 @@ + + + + + + Provides access to the parent cube texture or texture (mipmap) object, if this surface is a child level of a cube texture or a mipmap. This method can also provide access to the parent swap chain if the surface is a back-buffer child. + Reference identifier of the container being requested. + Address of a pointer to fill with the container pointer if the query succeeds. See Remarks. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves a device context. + Pointer to the device context for the surface. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if the argument is invalid. + + + Retrieves a description of the surface. + Pointer to a D3DSURFACE_DESC structure, describing the surface. + + If the method succeeds, the return value is D3D_OK. + D3DERR_INVALIDCALL is returned if the argument is invalid. + + + + Locks a rectangle on a surface. + Pointer to a D3DLOCKED_RECT structure that describes the locked region. + Pointer to a rectangle to lock. Specified by a pointer to a structure. Specifying NULL for this parameter expands the dirty region to cover the entire surface. + + Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are: + + + D3DLOCK_DISCARD + + + D3DLOCK_DONOTWAIT + + + D3DLOCK_NO_DIRTY_UPDATE + + + D3DLOCK_NOSYSLOCK + + + D3DLOCK_READONLY + + You may not specify a subrect when using D3DLOCK_DISCARD. For a description of the flags, see D3DLOCK. + + If the method succeeds, the return value is D3D_OK. + If the method fails, the return value can be D3DERR_INVALIDCALL or D3DERR_WASSTILLDRAWING. + + + + Release a device context handle. + Handle to a device context. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if the argument is invalid. + + + Unlocks a rectangle on a surface. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DSurface9 interface to query and prepare surfaces. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSwapChain9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSwapChain9.xml new file mode 100644 index 0000000000..a3ade6ef25 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSwapChain9.xml @@ -0,0 +1,65 @@ + + + + + + Retrieves a back buffer from the swap chain of the device. + Index of the back buffer object to return. Back buffers are numbered from 0 to the total number of back buffers - 1. A value of 0 returns the first back buffer, not the front buffer. The front buffer is not accessible through this method. Use to retrieve a copy of the front buffer. + Stereo view is not supported in Direct3D 9, so the only valid value for this parameter is D3DBACKBUFFER_TYPE_MONO. + Address of a pointer to an interface, representing the returned back buffer surface. + If the method succeeds, the return value is D3D_OK. If BackBuffer exceeds or equals the total number of back buffers, then the function fails and returns D3DERR_INVALIDCALL. + + + Retrieves the device associated with the swap chain. + Address of a pointer to an interface to fill with the device pointer, if the query succeeds. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves the display mode's spatial resolution, color resolution, and refresh frequency. + Pointer to a D3DDISPLAYMODE structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Generates a copy of the swapchain's front buffer and places that copy in a system memory buffer provided by the application. + Pointer to an interface that will receive a copy of the swapchain's front buffer. The data is returned in successive rows with no intervening space, starting from the vertically highest row to the lowest. For windowed mode, the size of the destination surface should be the size of the desktop. For full screen mode, the size of the destination surface should be the screen size. + If the method succeeds, the return value is D3D_OK. If BackBuffer exceeds or equals the total number of back buffers, the function fails and returns D3DERR_INVALIDCALL. + + + Retrieves the presentation parameters associated with a swap chain. + Pointer to the presentation parameters. See D3DPRESENT_PARAMETERS. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Returns information describing the raster of the monitor on which the swap chain is presented. + Pointer to a D3DRASTER_STATUS structure filled with information about the position or other status of the raster on the monitor driven by this adapter. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if pRasterStatus is invalid or if the device does not support reading the current scan line. To determine if the device supports reading the scan line, check for the D3DCAPS_READ_SCANLINE flag in the Caps member of . + + + Presents the contents of the next buffer in the sequence of back buffers owned by the swap chain. + Pointer to the source rectangle (see ). Use NULL to present the entire surface. This value must be NULL unless the swap chain was created with D3DSWAPEFFECT_COPY. If the rectangle exceeds the source surface, the rectangle is clipped to the source surface. + Pointer to the destination rectangle in client coordinates (see ). This value must be NULL unless the swap chain was created with D3DSWAPEFFECT_COPY. Use NULL to fill the entire client area. If the rectangle exceeds the destination client area, the rectangle is clipped to the destination client area. + Destination window whose client area is taken as the target for this presentation. If this value is NULL, the runtime uses the hDeviceWindow member of D3DPRESENT_PARAMETERS for the presentation. + + This value must be NULL unless the swap chain was created with D3DSWAPEFFECT_COPY. See Flipping Surfaces (Direct3D 9). + If this value is non-NULL, the contained region is expressed in back buffer coordinates. The rectangles within the region are the minimal set of pixels that need to be updated. This method takes these rectangles into account when optimizing the presentation by copying only the pixels within the region, or some suitably expanded set of rectangles. This is an aid to optimization only, and the application should not rely on the region being copied exactly. The implementation may choose to copy the whole source rectangle. + + + Allows the application to request that the method return immediately when the driver reports that it cannot schedule a presentation. Valid values are 0, or any combination of D3DPRESENT_DONOTWAIT or D3DPRESENT_LINEAR_CONTENT. + + + If dwFlags = 0, this method behaves as it did prior to Direct3D 9. Present will spin until the hardware is free, without returning an error. + + + If dwFlags = D3DPRESENT_DONOTWAIT, and the hardware is busy processing or waiting for a vertical sync interval, the method will return D3DERR_WASSTILLDRAWING. + + + If dwFlags = D3DPRESENT_LINEAR_CONTENT, gamma correction is performed from linear space to sRGB for windowed swap chains. This flag will take effect only when the driver exposes D3DCAPS3_LINEAR_TO_SRGB_PRESENTATION (see Gamma (Direct3D 9)). Applications should specify this flag if the backbuffer format is 16-bit floating point in order to match windowed mode present to fullscreen gamma behavior. + + + + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_DEVICELOST, D3DERR_DRIVERINTERNALERROR, D3DERR_INVALIDCALL, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY. + + + Applications use the methods of the IDirect3DSwapChain9 interface to manipulate a swap chain. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSwapChain9Ex.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSwapChain9Ex.xml new file mode 100644 index 0000000000..5af664dabc --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DSwapChain9Ex.xml @@ -0,0 +1,19 @@ + + + + + + Retrieves the display mode's spatial resolution, color resolution, refresh frequency, and rotation settings. + Pointer to a D3DDISPLAYMODEEX structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode. + Pointer to a D3DDISPLAYROTATION indicating the type of screen rotation the application will do. The value returned through this pointer is important when the D3DPRESENTFLAG_NOAUTOROTATE flag is used; otherwise, it can be set to NULL. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Returns the number of times the swapchain has been processed. + Pointer to a UINT to be filled with the number of times the method has been called. The count will also be incremented by calling some other APIs such as . + S_OK the method was successful. + + + Applications use the methods of the IDirect3DSwapChain9Ex interface to manipulate a swap chain. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DTexture9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DTexture9.xml new file mode 100644 index 0000000000..286718c7ea --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DTexture9.xml @@ -0,0 +1,53 @@ + + + + + + Adds a dirty region to a texture resource. + Pointer to a structure, specifying the dirty region to add. Specifying NULL expands the dirty region to cover the entire texture. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves a level description of a texture resource. + Identifies a level of the texture resource. This method returns a surface description for the level specified by this parameter. + Pointer to a D3DSURFACE_DESC structure, describing the returned level. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if one of the arguments is invalid. + + + Retrieves the specified texture surface level. + Identifies a level of the texture resource. This method returns a surface for the level specified by this parameter. The top-level surface is denoted by 0. + Address of a pointer to an interface, representing the returned surface. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one D3DERR_INVALIDCALL. + + + Locks a rectangle on a texture resource. + Specifies the level of the texture resource to lock. + Pointer to a D3DLOCKED_RECT structure, describing the locked region. + Pointer to a rectangle to lock. Specified by a pointer to a RECT structure. Specifying NULL for this parameter expands the dirty region to cover the entire texture. + + Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are: + + + D3DLOCK_DISCARD + + + D3DLOCK_NO_DIRTY_UPDATE + + + D3DLOCK_NOSYSLOCK + + + D3DLOCK_READONLY + + You may not specify a subrect when using D3DLOCK_DISCARD. For a description of the flags, see D3DLOCK. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Unlocks a rectangle on a texture resource. + Specifies the level of the texture resource to unlock. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DTexture9 interface to manipulate a texture resource. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexBuffer9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexBuffer9.xml new file mode 100644 index 0000000000..39eff38bbe --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexBuffer9.xml @@ -0,0 +1,43 @@ + + + + + + Retrieves a description of the vertex buffer resource. + Pointer to a D3DVERTEXBUFFER_DESC structure, describing the returned vertex buffer. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if the argument is invalid. + + + Locks a range of vertex data and obtains a pointer to the vertex buffer memory. + Offset into the vertex data to lock, in bytes. To lock the entire vertex buffer, specify 0 for both parameters, SizeToLock and OffsetToLock. + Size of the vertex data to lock, in bytes. To lock the entire vertex buffer, specify 0 for both parameters, SizeToLock and OffsetToLock. + VOID* pointer to a memory buffer containing the returned vertex data. + + Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are: + + + D3DLOCK_DISCARD + + + D3DLOCK_NO_DIRTY_UPDATE + + + D3DLOCK_NOSYSLOCK + + + D3DLOCK_READONLY + + + D3DLOCK_NOOVERWRITE + + For a description of the flags, see D3DLOCK. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Unlocks vertex data. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DVertexBuffer9 interface to manipulate vertex buffer resources. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexDeclaration9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexDeclaration9.xml new file mode 100644 index 0000000000..2cfb0baaed --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexDeclaration9.xml @@ -0,0 +1,19 @@ + + + + + + Gets the vertex shader declaration. + Array of vertex elements (see D3DVERTEXELEMENT9) that make up a vertex shader declaration. The application needs to allocate enough room for this. The vertex element array ends with the D3DDECL_END macro. + Number of elements in the array. The application needs to allocate enough room for this. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Gets the current device. + Pointer to the IDirect3DDevice9 interface that is returned. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be: D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DVertexDeclaration9 interface to encapsulate the vertex shader declaration. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexShader9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexShader9.xml new file mode 100644 index 0000000000..9f7ab04e78 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVertexShader9.xml @@ -0,0 +1,19 @@ + + + + + + Gets the device. + Pointer to the IDirect3DDevice9 interface that is returned. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Gets a pointer to the shader data. + Pointer to a buffer that contains the shader data. The application needs to allocate enough room for this. + Size of the data, in bytes. To get the buffer size that is needed to retrieve the data, set pData = NULL when calling GetFunction. Then call GetFunction with the returned size, to get the buffer data. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DVertexShader9 interface to encapsulate the functionality of a vertex shader. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVolume9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVolume9.xml new file mode 100644 index 0000000000..9a9a0c5d6f --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVolume9.xml @@ -0,0 +1,86 @@ + + + + + + Frees the specified private data associated with this volume. + Reference to the globally unique identifier that identifies the private data to free. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_NOTFOUND. + + + Provides access to the parent volume texture object, if this surface is a child level of a volume texture. + Reference identifier of the volume being requested. + Address of a pointer to fill with the container pointer, if the query succeeds. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves a description of the volume. + Pointer to a D3DVOLUME_DESC structure, describing the volume. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if the argument is invalid. + + + Retrieves the device associated with a volume. + Address of a pointer to an interface to fill with the device pointer, if the query succeeds. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Copies the private data associated with the volume to a provided buffer. + Reference to (C++) or address of (C) the globally unique identifier that identifies the private data to retrieve. + Pointer to a previously allocated buffer to fill with the requested private data if the call succeeds. The application calling this method is responsible for allocating and releasing this buffer. If this parameter is NULL, this method will return the buffer size in pSizeOfData. + Pointer to the size of the buffer at pData, in bytes. If this value is less than the actual size of the private data, such as 0, the method sets this parameter to the required buffer size, and the method returns D3DERR_MOREDATA. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_MOREDATA, D3DERR_NOTFOUND. + + + Locks a box on a volume resource. + Pointer to a D3DLOCKED_BOX structure, describing the locked region. + Pointer to a box to lock. Specified by a pointer to a D3DBOX structure. Specifying NULL for this parameter locks the entire volume. + + Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are: + + + D3DLOCK_DISCARD + + + D3DLOCK_NO_DIRTY_UPDATE + + + D3DLOCK_NOSYSLOCK + + + D3DLOCK_READONLY + + For a description of the flags, see D3DLOCK. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Associates data with the volume that is intended for use by the application, not by Direct3D. + Reference to the globally unique identifier that identifies the private data to set. + Pointer to a buffer that contains the data to associate with the volume. + Size of the buffer at pData in bytes. + + Value that describes the type of data being passed, or indicates to the application that the data should be invalidated when the resource changes. + + + Item + Description + + + (none) + If no flags are specified, Direct3D allocates memory to hold the data within the buffer and copies the data into the new buffer. The buffer allocated by Direct3D is automatically freed, as appropriate. + + + D3DSPD_IUNKNOWN + The data at pData is a pointer to an interface. SizeOfData must be set to the size of a pointer to an IUnknown interface, sizeof(IUnknown*). Direct3D automatically calls IUnknown through pData and IUnknown when the private data is destroyed. Private data will be destroyed by a subsequent call to IDirect3DVolume9.SetPrivateData with the same GUID, a subsequent call to , or when the object is released. For more information, see Remarks. + + + + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, E_OUTOFMEMORY. + + + Unlocks a box on a volume resource. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DVolume9 interface to manipulate volume resources. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVolumeTexture9.xml b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVolumeTexture9.xml new file mode 100644 index 0000000000..2f0746ac42 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9/IDirect3DVolumeTexture9.xml @@ -0,0 +1,53 @@ + + + + + + Adds a dirty region to a volume texture resource. + Pointer to a D3DBOX structure, specifying the dirty region to add. Specifying NULL expands the dirty region to cover the entire volume texture. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Retrieves a level description of a volume texture resource. + Identifies a level of the volume texture resource. This method returns a volume description for the level specified by this parameter. + Pointer to a D3DVOLUME_DESC structure, describing the returned volume texture level. + If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if one or more of the arguments are invalid. + + + Retrieves the specified volume texture level. + Identifies a level of the volume texture resource. This method returns a volume for the level specified by this parameter. + Address of a pointer to an interface, representing the returned volume level. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Locks a box on a volume texture resource. + Specifies the level of the volume texture resource to lock. + Pointer to a D3DLOCKED_BOX structure, describing the locked region. + Pointer to the volume to lock. This parameter is specified by a pointer to a D3DBOX structure. Specifying NULL for this parameter locks the entire volume level. + + Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are: + + + D3DLOCK_DISCARD + + + D3DLOCK_NO_DIRTY_UPDATE + + + D3DLOCK_NOSYSLOCK + + + D3DLOCK_READONLY + + For a description of the flags, see D3DLOCK. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Unlocks a box on a volume texture resource. + Specifies the level of the volume texture resource to unlock. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL. + + + Applications use the methods of the IDirect3DVolumeTexture9 interface to manipulate a volume texture resource. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DCAPS9.xml b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DCAPS9.xml new file mode 100644 index 0000000000..341e49da19 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DCAPS9.xml @@ -0,0 +1,1933 @@ + + + + + + Represents the capabilities of the hardware exposed through the Direct3D object. + + + Member of the D3DDEVTYPE enumerated type, which identifies what type of resources are used for processing vertices. + + + Adapter on which this Direct3D device was created. This ordinal is valid only to pass to methods of the interface that created this Direct3D device. The IDirect3D9 interface can always be retrieved by calling . + + + + The following driver-specific capability. + + + Value + Meaning + + + + + + + D3DCAPS_READ_SCANLINE + + + + + Display hardware is capable of returning the current scan line. + + + + + + + D3DCAPS_OVERLAY + + + + + The display driver supports an overlay DDI that allows for verification of overlay capabilities. For more information about the overlay DDI, see Overlay DDI.Differences between Direct3D 9 and Direct3D 9Ex:This flag is available in Direct3D 9Ex only.  + + + + + + Driver-specific capabilities identified in D3DCAPS2. + + + Driver-specific capabilities identified in D3DCAPS3. + + + + Bit mask of values representing what presentation swap intervals are available. + + + Value + Meaning + + + + + + + D3DPRESENT_INTERVAL_IMMEDIATE + + + + + The driver supports an immediate presentation swap interval. + + + + + + + D3DPRESENT_INTERVAL_ONE + + + + + The driver supports a presentation swap interval of every screen refresh. + + + + + + + D3DPRESENT_INTERVAL_TWO + + + + + The driver supports a presentation swap interval of every second screen refresh. + + + + + + + D3DPRESENT_INTERVAL_THREE + + + + + The driver supports a presentation swap interval of every third screen refresh. + + + + + + + D3DPRESENT_INTERVAL_FOUR + + + + + The driver supports a presentation swap interval of every fourth screen refresh. + + + + + + + Bit mask indicating what hardware support is available for cursors. Direct3D 9 does not define alpha-blending cursor capabilities. + + + Value + Meaning + + + + + + + D3DCURSORCAPS_COLOR + + + + + A full-color cursor is supported in hardware. Specifically, this flag indicates that the driver supports at least a hardware color cursor in high-resolution modes (with scan lines greater than or equal to 400). + + + + + + + D3DCURSORCAPS_LOWRES + + + + + A full-color cursor is supported in hardware. Specifically, this flag indicates that the driver supports a hardware color cursor in both high-resolution and low-resolution modes (with scan lines less than 400). + + + + + + + Flags identifying the capabilities of the device. + + + Value + Meaning + + + + + + + D3DDEVCAPS_CANBLTSYSTONONLOCAL + + + + + Device supports blits from system-memory textures to nonlocal video-memory textures. + + + + + + + D3DDEVCAPS_CANRENDERAFTERFLIP + + + + + Device can queue rendering commands after a page flip. Applications do not change their behavior if this flag is set; this capability means that the device is relatively fast. + + + + + + + D3DDEVCAPS_DRAWPRIMITIVES2 + + + + + Device can support at least a DirectX 5-compliant driver. + + + + + + + D3DDEVCAPS_DRAWPRIMITIVES2EX + + + + + Device can support at least a DirectX 7-compliant driver. + + + + + + + D3DDEVCAPS_DRAWPRIMTLVERTEX + + + + + Device exports an -aware hal. + + + + + + + D3DDEVCAPS_EXECUTESYSTEMMEMORY + + + + + Device can use execute buffers from system memory. + + + + + + + D3DDEVCAPS_EXECUTEVIDEOMEMORY + + + + + Device can use execute buffers from video memory. + + + + + + + D3DDEVCAPS_HWRASTERIZATION + + + + + Device has hardware acceleration for scene rasterization. + + + + + + + D3DDEVCAPS_HWTRANSFORMANDLIGHT + + + + + Device can support transformation and lighting in hardware. + + + + + + + D3DDEVCAPS_NPATCHES + + + + + Device supports N patches. + + + + + + + D3DDEVCAPS_PUREDEVICE + + + + + Device can support rasterization, transform, lighting, and shading in hardware. + + + + + + + D3DDEVCAPS_QUINTICRTPATCHES + + + + + Device supports quintic Bézier curves and B-splines. + + + + + + + D3DDEVCAPS_RTPATCHES + + + + + Device supports rectangular and triangular patches. + + + + + + + D3DDEVCAPS_RTPATCHHANDLEZERO + + + + + When this device capability is set, the hardware architecture does not require caching of any information, and uncached patches (handle zero) will be drawn as efficiently as cached ones. Note that setting D3DDEVCAPS_RTPATCHHANDLEZERO does not mean that a patch with handle zero can be drawn. A handle-zero patch can always be drawn whether this cap is set or not. + + + + + + + D3DDEVCAPS_SEPARATETEXTUREMEMORIES + + + + + Device is texturing from separate memory pools. + + + + + + + D3DDEVCAPS_TEXTURENONLOCALVIDMEM + + + + + Device can retrieve textures from non-local video memory. + + + + + + + D3DDEVCAPS_TEXTURESYSTEMMEMORY + + + + + Device can retrieve textures from system memory. + + + + + + + D3DDEVCAPS_TEXTUREVIDEOMEMORY + + + + + Device can retrieve textures from device memory. + + + + + + + D3DDEVCAPS_TLVERTEXSYSTEMMEMORY + + + + + Device can use buffers from system memory for transformed and lit vertices. + + + + + + + D3DDEVCAPS_TLVERTEXVIDEOMEMORY + + + + + Device can use buffers from video memory for transformed and lit vertices. + + + + + + Miscellaneous driver primitive capabilities. See D3DPMISCCAPS. + + + + Information on raster-drawing capabilities. This member can be one or more of the following flags. + + + Value + Meaning + + + + + + + D3DPRASTERCAPS_ANISOTROPY + + + + + Device supports anisotropic filtering. + + + + + + + D3DPRASTERCAPS_COLORPERSPECTIVE + + + + + Device iterates colors perspective correctly. + + + + + + + D3DPRASTERCAPS_DITHER + + + + + Device can dither to improve color resolution. + + + + + + + D3DPRASTERCAPS_DEPTHBIAS + + + + + Device supports legacy depth bias. For true depth bias, see D3DPRASTERCAPS_SLOPESCALEDEPTHBIAS. + + + + + + + D3DPRASTERCAPS_FOGRANGE + + + + + Device supports range-based fog. In range-based fog, the distance of an object from the viewer is used to compute fog effects, not the depth of the object (that is, the z-coordinate) in the scene. + + + + + + + D3DPRASTERCAPS_FOGTABLE + + + + + Device calculates the fog value by referring to a lookup table containing fog values that are indexed to the depth of a given pixel. + + + + + + + D3DPRASTERCAPS_FOGVERTEX + + + + + Device calculates the fog value during the lighting operation and interpolates the fog value during rasterization. + + + + + + + D3DPRASTERCAPS_MIPMAPLODBIAS + + + + + Device supports level-of-detail bias adjustments. These bias adjustments enable an application to make a mipmap appear crisper or less sharp than it normally would. For more information about level-of-detail bias in mipmaps, see D3DSAMP_MIPMAPLODBIAS. + + + + + + + D3DPRASTERCAPS_MULTISAMPLE_TOGGLE + + + + + Device supports toggling multisampling on and off between and (using D3DRS_MULTISAMPLEANTIALIAS). + + + + + + + D3DPRASTERCAPS_SCISSORTEST + + + + + Device supports scissor test. See Scissor Test (Direct3D 9). + + + + + + + D3DPRASTERCAPS_SLOPESCALEDEPTHBIAS + + + + + Device performs true slope-scale based depth bias. This is in contrast to the legacy style depth bias. + + + + + + + D3DPRASTERCAPS_WBUFFER + + + + + Device supports depth buffering using w. + + + + + + + D3DPRASTERCAPS_WFOG + + + + + Device supports w-based fog. W-based fog is used when a perspective projection matrix is specified, but affine projections still use z-based fog. The system considers a projection matrix that contains a nonzero value in the [3][4] element to be a perspective projection matrix. + + + + + + + D3DPRASTERCAPS_ZBUFFERLESSHSR + + + + + Device can perform hidden-surface removal (HSR) without requiring the application to sort polygons and without requiring the allocation of a depth-buffer. This leaves more video memory for textures. The method used to perform HSR is hardware-dependent and is transparent to the application.Z-bufferless HSR is performed if no depth-buffer surface is associated with the rendering-target surface and the depth-buffer comparison test is enabled (that is, when the state value associated with the D3DRS_ZENABLE enumeration constant is set to TRUE). + + + + + + + D3DPRASTERCAPS_ZFOG + + + + + Device supports z-based fog. + + + + + + + D3DPRASTERCAPS_ZTEST + + + + + Device can perform z-test operations. This effectively renders a primitive and indicates whether any z pixels have been rendered. + + + + + + + Z-buffer comparison capabilities. This member can be one or more of the following flags. + + + Value + Meaning + + + + + + + D3DPCMPCAPS_ALWAYS + + + + + Always pass the z-test. + + + + + + + D3DPCMPCAPS_EQUAL + + + + + Pass the z-test if the new z equals the current z. + + + + + + + D3DPCMPCAPS_GREATER + + + + + Pass the z-test if the new z is greater than the current z. + + + + + + + D3DPCMPCAPS_GREATEREQUAL + + + + + Pass the z-test if the new z is greater than or equal to the current z. + + + + + + + D3DPCMPCAPS_LESS + + + + + Pass the z-test if the new z is less than the current z. + + + + + + + D3DPCMPCAPS_LESSEQUAL + + + + + Pass the z-test if the new z is less than or equal to the current z. + + + + + + + D3DPCMPCAPS_NEVER + + + + + Always fail the z-test. + + + + + + + D3DPCMPCAPS_NOTEQUAL + + + + + Pass the z-test if the new z does not equal the current z. + + + + + + + Source-blending capabilities. This member can be one or more of the following flags. (The RGBA values of the source and destination are indicated by the subscripts s and d.) + + + Value + Meaning + + + + + + + D3DPBLENDCAPS_BLENDFACTOR + + + + + The driver supports both D3DBLEND_BLENDFACTOR and D3DBLEND_INVBLENDFACTOR. See D3DBLEND. + + + + + + + D3DPBLENDCAPS_BOTHINVSRCALPHA + + + + + Source blend factor is (1 - Aₛ, 1 - Aₛ, 1 - Aₛ, 1 - Aₛ) and destination blend factor is (Aₛ, Aₛ, Aₛ, Aₛ); the destination blend selection is overridden. + + + + + + + D3DPBLENDCAPS_BOTHSRCALPHA + + + + + The driver supports the D3DBLEND_BOTHSRCALPHA blend mode. (This blend mode is obsolete. For more information, see D3DBLEND.) + + + + + + + D3DPBLENDCAPS_DESTALPHA + + + + + Blend factor is (Ad, Ad, Ad, Ad). + + + + + + + D3DPBLENDCAPS_DESTCOLOR + + + + + Blend factor is (Rd, Gd, Bd, Ad). + + + + + + + D3DPBLENDCAPS_INVDESTALPHA + + + + + Blend factor is (1 - Ad, 1 - Ad, 1 - Ad, 1 - Ad). + + + + + + + D3DPBLENDCAPS_INVDESTCOLOR + + + + + Blend factor is (1 - Rd, 1 - Gd, 1 - Bd, 1 - Ad). + + + + + + + D3DPBLENDCAPS_INVSRCALPHA + + + + + Blend factor is (1 - Aₛ, 1 - Aₛ, 1 - Aₛ, 1 - Aₛ). + + + + + + + D3DPBLENDCAPS_INVSRCCOLOR + + + + + Blend factor is (1 - Rₛ, 1 - Gₛ, 1 - Bₛ, 1 - Aₛ). + + + + + + + D3DPBLENDCAPS_INVSRCCOLOR2 + + + + + Blend factor is (1 - PSOutColor[1]r, 1 - PSOutColor[1]g, 1 - PSOutColor[1]b, not used)). See Render Target Blending.Differences between Direct3D 9 and Direct3D 9Ex:This flag is available in Direct3D 9Ex only.  + + + + + + + D3DPBLENDCAPS_ONE + + + + + Blend factor is (1, 1, 1, 1). + + + + + + + D3DPBLENDCAPS_SRCALPHA + + + + + Blend factor is (Aₛ, Aₛ, Aₛ, Aₛ). + + + + + + + D3DPBLENDCAPS_SRCALPHASAT + + + + + Blend factor is (f, f, f, 1); f = min(Aₛ, 1 - Ad). + + + + + + + D3DPBLENDCAPS_SRCCOLOR + + + + + Blend factor is (Rₛ, Gₛ, Bₛ, Aₛ). + + + + + + + D3DPBLENDCAPS_SRCCOLOR2 + + + + + Blend factor is (PSOutColor[1]r, PSOutColor[1]g, PSOutColor[1]b, not used). See Render Target Blending.Differences between Direct3D 9 and Direct3D 9Ex:This flag is available in Direct3D 9Ex only.  + + + + + + + D3DPBLENDCAPS_ZERO + + + + + Blend factor is (0, 0, 0, 0). + + + + + + Destination-blending capabilities. This member can be the same capabilities that are defined for the SrcBlendCaps member. + + + Alpha-test comparison capabilities. This member can include the same capability flags defined for the ZCmpCaps member. If this member contains only the D3DPCMPCAPS_ALWAYS capability or only the D3DPCMPCAPS_NEVER capability, the driver does not support alpha tests. Otherwise, the flags identify the individual comparisons that are supported for alpha testing. + + + + Shading operations capabilities. It is assumed, in general, that if a device supports a given command at all, it supports the D3DSHADE_FLAT mode (as specified in the D3DSHADEMODE enumerated type). This flag specifies whether the driver can also support Gouraud shading and whether alpha color components are supported. When alpha components are not supported, the alpha value of colors generated is implicitly 255. This is the maximum possible alpha (that is, the alpha component is at full intensity). + The color, specular highlights, fog, and alpha interpolants of a triangle each have capability flags that an application can use to find out how they are implemented by the device driver. + This member can be one or more of the following flags. + + + Value + Meaning + + + + + + + D3DPSHADECAPS_ALPHAGOURAUDBLEND + + + + + Device can support an alpha component for Gouraud-blended transparency (the D3DSHADE_GOURAUD state for the D3DSHADEMODE enumerated type). In this mode, the alpha color component of a primitive is provided at vertices and interpolated across a face along with the other color components. + + + + + + + D3DPSHADECAPS_COLORGOURAUDRGB + + + + + Device can support colored Gouraud shading. In this mode, the per-vertex color components (red, green, and blue) are interpolated across a triangle face. + + + + + + + D3DPSHADECAPS_FOGGOURAUD + + + + + Device can support fog in the Gouraud shading mode. + + + + + + + D3DPSHADECAPS_SPECULARGOURAUDRGB + + + + + Device supports Gouraud shading of specular highlights. + + + + + + + Miscellaneous texture-mapping capabilities. This member can be one or more of the following flags. + + + Value + Meaning + + + + + + + D3DPTEXTURECAPS_ALPHA + + + + + Alpha in texture pixels is supported. + + + + + + + D3DPTEXTURECAPS_ALPHAPALETTE + + + + + Device can draw alpha from texture palettes. + + + + + + + D3DPTEXTURECAPS_CUBEMAP + + + + + Supports cube textures. + + + + + + + D3DPTEXTURECAPS_CUBEMAP_POW2 + + + + + Device requires that cube texture maps have dimensions specified as powers of two. + + + + + + + D3DPTEXTURECAPS_MIPCUBEMAP + + + + + Device supports mipmapped cube textures. + + + + + + + D3DPTEXTURECAPS_MIPMAP + + + + + Device supports mipmapped textures. + + + + + + + D3DPTEXTURECAPS_MIPVOLUMEMAP + + + + + Device supports mipmapped volume textures. + + + + + + + D3DPTEXTURECAPS_NONPOW2CONDITIONAL + + + + + D3DPTEXTURECAPS_POW2 is also set, conditionally supports the use of 2D textures with dimensions that are not powers of two. A device that exposes this capability can use such a texture if all of the following requirements are met.The texture addressing mode for the texture stage is set to D3DTADDRESS_CLAMP.Texture wrapping for the texture stage is disabled (D3DRS_WRAP n set to 0).Mipmapping is not in use (use magnification filter only).Texture formats must not be D3DFMT_DXT1 through D3DFMT_DXT5.If this flag is not set, and D3DPTEXTURECAPS_POW2 is also not set, then unconditional support is provided for 2D textures with dimensions that are not powers of two.A texture that is not a power of two cannot be set at a stage that will be read based on a shader computation (such as the bem - ps and texm3x3 - ps instructions in pixel shaders versions 1_0 to 1_3). For example, these textures can be used to store bumps that will be fed into texture reads, but not the environment maps that are used in texbem - ps, texbeml - ps, and texm3x3spec - ps. This means that a texture with dimensions that are not powers of two cannot be addressed or sampled using texture coordinates computed within the shader. This type of operation is known as a dependent read and cannot be performed on these types of textures. + + + + + + + D3DPTEXTURECAPS_NOPROJECTEDBUMPENV + + + + + Device does not support a projected bump-environment lookup operation in programmable and fixed function shaders. + + + + + + + D3DPTEXTURECAPS_PERSPECTIVE + + + + + Perspective correction texturing is supported. + + + + + + + D3DPTEXTURECAPS_POW2 + + + + + If D3DPTEXTURECAPS_NONPOW2CONDITIONAL is not set, all textures must have widths and heights specified as powers of two. This requirement does not apply to either cube textures or volume textures.If D3DPTEXTURECAPS_NONPOW2CONDITIONAL is also set, conditionally supports the use of 2D textures with dimensions that are not powers of two. See D3DPTEXTURECAPS_NONPOW2CONDITIONAL description.If this flag is not set, and D3DPTEXTURECAPS_NONPOW2CONDITIONAL is also not set, then unconditional support is provided for 2D textures with dimensions that are not powers of two. + + + + + + + D3DPTEXTURECAPS_PROJECTED + + + + + Supports the D3DTTFF_PROJECTED texture transformation flag. When applied, the device divides transformed texture coordinates by the last texture coordinate. If this capability is present, then the projective divide occurs per pixel. If this capability is not present, but the projective divide needs to occur anyway, then it is performed on a per-vertex basis by the Direct3D runtime. + + + + + + + D3DPTEXTURECAPS_SQUAREONLY + + + + + All textures must be square. + + + + + + + D3DPTEXTURECAPS_TEXREPEATNOTSCALEDBYSIZE + + + + + Texture indices are not scaled by the texture size prior to interpolation. + + + + + + + D3DPTEXTURECAPS_VOLUMEMAP + + + + + Device supports volume textures. + + + + + + + D3DPTEXTURECAPS_VOLUMEMAP_POW2 + + + + + Device requires that volume texture maps have dimensions specified as powers of two. + + + + + + Texture-filtering capabilities for a texture. Per-stage filtering capabilities reflect which filtering modes are supported for texture stages when performing multiple-texture blending. This member can be any combination of the per-stage texture-filtering flags defined in D3DPTFILTERCAPS. + + + Texture-filtering capabilities for a cube texture. Per-stage filtering capabilities reflect which filtering modes are supported for texture stages when performing multiple-texture blending. This member can be any combination of the per-stage texture-filtering flags defined in D3DPTFILTERCAPS. + + + Texture-filtering capabilities for a volume texture. Per-stage filtering capabilities reflect which filtering modes are supported for texture stages when performing multiple-texture blending. This member can be any combination of the per-stage texture-filtering flags defined in D3DPTFILTERCAPS. + + + + Texture-addressing capabilities for texture objects. This member can be one or more of the following flags. + + + Value + Meaning + + + + + + + D3DPTADDRESSCAPS_BORDER + + + + + Device supports setting coordinates outside the range [0.0, 1.0] to the border color, as specified by the D3DSAMP_BORDERCOLOR texture-stage state. + + + + + + + D3DPTADDRESSCAPS_CLAMP + + + + + Device can clamp textures to addresses. + + + + + + + D3DPTADDRESSCAPS_INDEPENDENTUV + + + + + Device can separate the texture-addressing modes of the u and v coordinates of the texture. This ability corresponds to the D3DSAMP_ADDRESSU and D3DSAMP_ADDRESSV render-state values. + + + + + + + D3DPTADDRESSCAPS_MIRROR + + + + + Device can mirror textures to addresses. + + + + + + + D3DPTADDRESSCAPS_MIRRORONCE + + + + + Device can take the absolute value of the texture coordinate (thus, mirroring around 0) and then clamp to the maximum value. + + + + + + + D3DPTADDRESSCAPS_WRAP + + + + + Device can wrap textures to addresses. + + + + + + Texture-addressing capabilities for a volume texture. This member can be one or more of the flags defined for the TextureAddressCaps member. + + + + Defines the capabilities for line-drawing primitives. + + + Value + Meaning + + + + + + + D3DLINECAPS_ALPHACMP + + + + + Supports alpha-test comparisons. + + + + + + + D3DLINECAPS_ANTIALIAS + + + + + Antialiased lines are supported. + + + + + + + D3DLINECAPS_BLEND + + + + + Supports source-blending. + + + + + + + D3DLINECAPS_FOG + + + + + Supports fog. + + + + + + + D3DLINECAPS_TEXTURE + + + + + Supports texture-mapping. + + + + + + + D3DLINECAPS_ZTEST + + + + + Supports z-buffer comparisons. + + + + + + Maximum texture width for this device. + + + Maximum texture height for this device. + + + Maximum value for any of the three dimensions (width, height, and depth) of a volume texture. + + + + This number represents the maximum range of the integer bits of the post-normalized texture coordinates. A texture coordinate is stored as a 32-bit signed integer using 27 bits to store the integer part and 5 bits for the floating point fraction. The maximum integer index, 2²⁷, is used to determine the maximum texture coordinate, depending on how the hardware does texture-coordinate scaling. + Some hardware reports the cap D3DPTEXTURECAPS_TEXREPEATNOTSCALEDBYSIZE. For this case, the device defers scaling texture coordinates by the texture size until after interpolation and application of the texture address mode, so the number of times a texture can be wrapped is given by the integer value in MaxTextureRepeat. + Less desirably, on some hardware D3DPTEXTURECAPS_TEXREPEATNOTSCALEDBYSIZE is not set and the device scales the texture coordinates by the texture size (using the highest level of detail) prior to interpolation. This limits the number of times a texture can be wrapped to MaxTextureRepeat / texture size. + For example, assume that MaxTextureRepeat is equal to 32k and the size of the texture is 4k. If the hardware sets D3DPTEXTURECAPS_TEXREPEATNOTSCALEDBYSIZE, then the number of times a texture can be wrapped is equal to MaxTextureRepeat, which is 32k in this example. Otherwise, the number of times a texture can be wrapped is equal to MaxTextureRepeat divided by texture size, which is 32k/4k in this example. + + + + Maximum texture aspect ratio supported by the hardware, typically a power of 2. + + + Maximum valid value for the D3DSAMP_MAXANISOTROPY texture-stage state. + + + Maximum W-based depth value that the device supports. + + + Screen-space coordinate of the guard-band clipping region. Coordinates inside this rectangle but outside the viewport rectangle are automatically clipped. + + + Screen-space coordinate of the guard-band clipping region. Coordinates inside this rectangle but outside the viewport rectangle are automatically clipped. + + + Screen-space coordinate of the guard-band clipping region. Coordinates inside this rectangle but outside the viewport rectangle are automatically clipped. + + + Screen-space coordinate of the guard-band clipping region. Coordinates inside this rectangle but outside the viewport rectangle are automatically clipped. + + + Number of pixels to adjust the extents rectangle outward to accommodate antialiasing kernels. + + + + Flags specifying supported stencil-buffer operations. Stencil operations are assumed to be valid for all three stencil-buffer operation render states (D3DRS_STENCILFAIL, D3DRS_STENCILPASS, and D3DRS_STENCILZFAIL). + For more information, see D3DSTENCILCAPS. + + + + + Flexible vertex format capabilities. + + + Value + Meaning + + + + + + + D3DFVFCAPS_DONOTSTRIPELEMENTS + + + + + It is preferable that vertex elements not be stripped. That is, if the vertex format contains elements that are not used with the current render states, there is no need to regenerate the vertices. If this capability flag is not present, stripping extraneous elements from the vertex format provides better performance. + + + + + + + D3DFVFCAPS_PSIZE + + + + + Point size is determined by either the render state or the vertex data. If an FVF is used, point size can come from point size data in the vertex declaration. Otherwise, point size is determined by the render state D3DRS_POINTSIZE. If the application provides point size in both (the render state and the vertex declaration), the vertex data overrides the render-state data. + + + + + + + D3DFVFCAPS_TEXCOORDCOUNTMASK + + + + + Masks the low WORD of FVFCaps. These bits, cast to the WORD data type, describe the total number of texture coordinate sets that the device can simultaneously use for multiple texture blending. (You can use up to eight texture coordinate sets for any vertex, but the device can blend using only the specified number of texture coordinate sets.) + + + + + + + Combination of flags describing the texture operations supported by this device. The following flags are defined. + + + Value + Meaning + + + + + + + D3DTEXOPCAPS_ADD + + + + + The D3DTOP_ADD texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_ADDSIGNED + + + + + The D3DTOP_ADDSIGNED texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_ADDSIGNED2X + + + + + The D3DTOP_ADDSIGNED2X texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_ADDSMOOTH + + + + + The D3DTOP_ADDSMOOTH texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_BLENDCURRENTALPHA + + + + + The D3DTOP_BLENDCURRENTALPHA texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_BLENDDIFFUSEALPHA + + + + + The D3DTOP_BLENDDIFFUSEALPHA texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_BLENDFACTORALPHA + + + + + The D3DTOP_BLENDFACTORALPHA texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_BLENDTEXTUREALPHA + + + + + The D3DTOP_BLENDTEXTUREALPHA texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_BLENDTEXTUREALPHAPM + + + + + The D3DTOP_BLENDTEXTUREALPHAPM texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_BUMPENVMAP + + + + + The D3DTOP_BUMPENVMAP texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_BUMPENVMAPLUMINANCE + + + + + The D3DTOP_BUMPENVMAPLUMINANCE texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_DISABLE + + + + + The D3DTOP_DISABLE texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_DOTPRODUCT3 + + + + + The D3DTOP_DOTPRODUCT3 texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_LERP + + + + + The D3DTOP_LERP texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_MODULATE + + + + + The D3DTOP_MODULATE texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_MODULATE2X + + + + + The D3DTOP_MODULATE2X texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_MODULATE4X + + + + + The D3DTOP_MODULATE4X texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_MODULATEALPHA_ADDCOLOR + + + + + The D3DTOP_MODULATEALPHA_ADDCOLOR texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_MODULATECOLOR_ADDALPHA + + + + + The D3DTOP_MODULATECOLOR_ADDALPHA texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_MODULATEINVALPHA_ADDCOLOR + + + + + The D3DTOP_MODULATEINVALPHA_ADDCOLOR texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_MODULATEINVCOLOR_ADDALPHA + + + + + The D3DTOP_MODULATEINVCOLOR_ADDALPHA texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_MULTIPLYADD + + + + + The D3DTOP_MULTIPLYADD texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_PREMODULATE + + + + + The D3DTOP_PREMODULATE texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_SELECTARG1 + + + + + The D3DTOP_SELECTARG1 texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_SELECTARG2 + + + + + The D3DTOP_SELECTARG2 texture-blending operation is supported. + + + + + + + D3DTEXOPCAPS_SUBTRACT + + + + + The D3DTOP_SUBTRACT texture-blending operation is supported. + + + + + + Maximum number of texture-blending stages supported in the fixed function pipeline. This value is the number of blenders available. In the programmable pixel pipeline, this corresponds to the number of unique texture registers used by pixel shader instructions. + + + + Maximum number of textures that can be simultaneously bound to the fixed-function pipeline sampler stages. If the same texture is bound to two sampler stages, it counts as two textures. + This value has no meaning in the programmable pipeline where the number of sampler stages is determined by each pixel shader version. Each pixel shader version also determines the number of texture declaration instructions. See Pixel Shaders. + + + + Vertex processing capabilities. For a given physical device, this capability might vary across Direct3D devices depending on the parameters supplied to . See D3DVTXPCAPS. + + + Maximum number of lights that can be active simultaneously. For a given physical device, this capability might vary across Direct3D devices depending on the parameters supplied to . + + + Maximum number of user-defined clipping planes supported. This member can be 0. For a given physical device, this capability may vary across Direct3D devices depending on the parameters supplied to . + + + Maximum number of matrices that this device can apply when performing multimatrix vertex blending. For a given physical device, this capability may vary across Direct3D devices depending on the parameters supplied to . + + + + DWORD value that specifies the maximum matrix index that can be indexed into using the per-vertex indices. The number of matrices is MaxVertexBlendMatrixIndex + 1, which is the size of the matrix palette. If normals are present in the vertex data that needs to be blended for lighting, then the number of matrices is half the number specified by this capability flag. If MaxVertexBlendMatrixIndex is set to zero, the driver does not support indexed vertex blending. If this value is not zero then the valid range of indices is zero through MaxVertexBlendMatrixIndex. + A zero value for MaxVertexBlendMatrixIndex indicates that the driver does not support indexed matrices. + When software vertex processing is used, 256 matrices could be used for indexed vertex blending, with or without normal blending. + For a given physical device, this capability may vary across Direct3D devices depending on the parameters supplied to . + + + + Maximum size of a point primitive. If set to 1.0f then device does not support point size control. The range is greater than or equal to 1.0f. + + + + Maximum number of primitives for each call. There are two cases: + + + If MaxPrimitiveCount is not equal to 0xffff, you can draw at most MaxPrimitiveCount primitives with each draw call. + + + However, if MaxPrimitiveCount equals 0xffff, you can still draw at most MaxPrimitiveCount primitive, but you may also use no more than MaxPrimitiveCount unique vertices (since each primitive can potentially use three different vertices). + + + + + + Maximum size of indices supported for hardware vertex processing. It is possible to create 32-bit index buffers; however, you will not be able to render with the index buffer unless this value is greater than 0x0000FFFF. + + + Maximum number of concurrent data streams for . The valid range is 1 to 16. Note that if this value is 0, then the driver is not a Direct3D 9 driver. + + + Maximum stride for . + + + Two numbers that represent the vertex shader main and sub versions. For more information about the instructions supported for each vertex shader version, see Version 1_x, Version 2_0, Version 2_0 Extended, or Version 3_0. + + + The number of vertex shader Vertex Shader Registers that are reserved for constants. + + + Two numbers that represent the pixel shader main and sub versions. For more information about the instructions supported for each pixel shader version, see Version 1_x, Version 2_0, Version 2_0 Extended, or Version 3_0. + + + Maximum value of pixel shader arithmetic component. This value indicates the internal range of values supported for pixel color blending operations. Within the range that they report to, implementations must allow data to pass through pixel processing unmodified (unclamped). Normally, the value of this member is an absolute value. For example, a 1.0 indicates that the range is -1.0 to 1, and an 8.0 indicates that the range is -8.0 to 8.0. The value must be >= 1.0 for any hardware that supports pixel shaders. + + + Device driver capabilities for adaptive tessellation. For more information, see D3DDEVCAPS2 + + + TBD + + + TBD + + + + This number indicates which device is the master for this subordinate. This number is taken from the same space as the adapter values. + For multihead support, one head will be denoted the master head, and all other heads on the same card will be denoted subordinate heads. If more than one multihead adapter is present in a system, the master and its subordinates from one multihead adapter are called a group. + + + + This number indicates the order in which heads are referenced by the API. The value for the master adapter is always 0. These values do not correspond to the adapter ordinals. They apply only to heads within a group. + + + Number of adapters in this adapter group (only if master). This will be 1 for conventional adapters. The value will be greater than 1 for the master adapter of a multihead card. The value will be 0 for a subordinate adapter of a multihead card. Each card can have at most one master, but may have many subordinates. + + + A combination of one or more data types contained in a vertex declaration. See D3DDTCAPS. + + + Number of simultaneous render targets. This number must be at least one. + + + + Combination of constants that describe the operations supported by . The flags that may be set in this field are: + + + Constant + Description + + + D3DPTFILTERCAPS_MINFPOINT + Device supports point-sample filtering for minifying rectangles. This filter type is requested by calling using D3DTEXF_POINT. + + + D3DPTFILTERCAPS_MAGFPOINT + Device supports point-sample filtering for magnifying rectangles. This filter type is requested by calling using D3DTEXF_POINT. + + + D3DPTFILTERCAPS_MINFLINEAR + Device supports bilinear interpolation filtering for minifying rectangles. This filter type is requested by calling using D3DTEXF_LINEAR. + + + D3DPTFILTERCAPS_MAGFLINEAR + Device supports bilinear interpolation filtering for magnifying rectangles. This filter type is requested by calling using D3DTEXF_LINEAR. + +  For more information, see D3DTEXTUREFILTERTYPE and D3DTEXTUREFILTERTYPE. + + + Device supports vertex shader version 2_0 extended capability. See . + + + Device supports pixel shader version 2_0 extended capability. See . + + + Device supports vertex shader texture filter capability. See D3DPTFILTERCAPS. + + + Maximum number of vertex shader instructions that can be run when using flow control. The maximum number of instructions that can be programmed is MaxVertexShader30InstructionSlots. + + + Maximum number of pixel shader instructions that can be run when using flow control. The maximum number of instructions that can be programmed is MaxPixelShader30InstructionSlots. + + + Maximum number of vertex shader instruction slots supported. The maximum value that can be set on this cap is 32768. Devices that support vs_3_0 are required to support at least 512 instruction slots. + + + Maximum number of pixel shader instruction slots supported. The maximum value that can be set on this cap is 32768. Devices that support ps_3_0 are required to support at least 512 instruction slots. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DCONTENTPROTECTIONCAPS.xml b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DCONTENTPROTECTIONCAPS.xml new file mode 100644 index 0000000000..a6695d8071 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DCONTENTPROTECTIONCAPS.xml @@ -0,0 +1,198 @@ + + + + + + Describes the content protection capabilities of a display driver. To get the capabilities, call . + + + + Bitwise OR of zero or more flags. + + + Value + Meaning + + + + + + + D3DCPCAPS_SOFTWARE + + + + 0x00000001 + + + + The encryption is implemented in software by the driver. + + + + + + + D3DCPCAPS_HARDWARE + + + + 0x00000002 + + + + The encryption is implemented in hardware by the GPU. + + + + + + + D3DCPCAPS_PROTECTIONALWAYSON + + + + 0x00000004 + + + + Content protection is always applied to a protected Direct3D surface, regardless of whether the application explicitly enables content protection. + + + + + + + D3DCPCAPS_PARTIALDECRYPTION + + + + 0x00000008 + + + + The driver can use partially encrypted buffers. If this capability is not present, the entire buffer must be either encrypted or clear. + + + + + + + D3DCPCAPS_CONTENTKEY + + + + 0x00000010 + + + + The driver can encrypt data using a separate content key that is encrypted using the session key. For more information, see . + + + + + + + D3DCPCAPS_FRESHENSESSIONKEY + + + + 0x00000020 + + + + The driver can refresh the session key without renegotiating the key. To refresh the session key, call . + + + + + + + D3DCPCAPS_ENCRYPTEDREADBACK + + + + 0x00000040 + + + + The driver can read back encrypted data from a protected surface, using the method. + + + + + + + D3DCPCAPS_ENCRYPTEDREADBACKKEY + + + + 0x00000080 + + + + The driver requires a separate key to read encrypted data from a protected surface. To get this second key, call . + + + + + + + D3DCPCAPS_SEQUENTIAL_CTR_IV + + + + 0x00000100 + + + + If the encryption type is D3DCRYPTOTYPE_AES128_CTR, the application must use a sequential count in the structure. For more information, see the remarks for DXVA2_AES_CTR_IV. + + + + + + + Specifies the type of key exchange required to negotiate the session key. The following GUIDs are defined. + + + Value + Meaning + + + + + + + D3DKEYEXCHANGE_RSAES_OAEP + + + + + The decoder encrypts the session key using RSA Encryption Scheme - Optimal Asymmetric Encryption Padding (RSAES-OAEP). + + + + + + + D3DKEYEXCHANGE_DXVA + + + + + Use the key exchange mechanism defined for DirectX Video Acceleration 2 (DXVA-2). + + + + + + The memory alignment required for buffers used by the GPU cryptographic engine. If the application uses a system memory buffer to pass encrypted content to the GPU, or to read back encrypted content from the GPU, the buffer's starting address must be a multiple of this value. + + + The block alignment required by the GPU cryptographic engine. The size of data to be encrypted must be a multiple of this value. + + + The total amount of memory that can be used to hold protected surfaces. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DOVERLAYCAPS.xml b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DOVERLAYCAPS.xml new file mode 100644 index 0000000000..84b4a8eb58 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DOVERLAYCAPS.xml @@ -0,0 +1,145 @@ + + + + + + Specifies hardware overlay capabilities for a Direct3D device. + + + + Contains a bitwise OR of the following flags. + + + Value + Meaning + + + + + + + D3DOVERLAYCAPS_FULLRANGERGB + + + + 0x00000001 + + + + The overlay supports RGB with a nominal range of 0–255 per channel. + + + + + + + D3DOVERLAYCAPS_LIMITEDRANGERGB + + + + 0x00000002 + + + + The overlay supports RGB with a nominal range of 16–235 per channel. Reference black is (16,16,16) and reference white is (235,235,235). + + + + + + + D3DOVERLAYCAPS_YCbCr_BT601 + + + + 0x00000004 + + + + The overlay supports the BT.601 definition of YUV. + + + + + + + D3DOVERLAYCAPS_YCbCr_BT709 + + + + 0x00000008 + + + + The overlay supports the BT.709 definition of YUV. + + + + + + + D3DOVERLAYCAPS_YCbCr_BT601_xvYCC + + + + 0x00000010 + + + + The overlay supports extended YCbCr (xvYCC) for BT.601 YUV. + + + + + + + D3DOVERLAYCAPS_YCbCr_BT709_xvYCC + + + + 0x00000020 + + + + The overlay supports extended YCbCr (xvYCC) for BT.709 YUV. + + + + + + + D3DOVERLAYCAPS_STRETCHX + + + + 0x00000040 + + + + The device can stretch and shrink the overlay data arbitrarily in the horizontal direction. + + + + + + + D3DOVERLAYCAPS_STRETCHY + + + + 0x00000080 + + + + The device can stretch and shrink the overlay data arbitrarily in the vertical direction. + + + + + + The maximum overlay width after stretching. + + + The maximum overlay height after stretching. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DPSHADERCAPS2_0.xml b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DPSHADERCAPS2_0.xml new file mode 100644 index 0000000000..a3b2b7bcc5 --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DPSHADERCAPS2_0.xml @@ -0,0 +1,23 @@ + + + + + + Pixel shader driver caps. + + + Instruction predication is supported if this value is nonzero. See setp_comp - vs. + + + Either 0 or 24, which represents the depth of the dynamic flow control instruction nesting. See D3DPSHADERCAPS2_0. + + + The number of temporary registers supported. See D3DPSHADERCAPS2_0. + + + The depth of nesting of the loop - vs/rep - vs and call - vs/callnz bool - vs instructions. See D3DPSHADERCAPS2_0. + + + The number of instruction slots supported. See D3DPSHADERCAPS2_0. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DVSHADERCAPS2_0.xml b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DVSHADERCAPS2_0.xml new file mode 100644 index 0000000000..8799d145cc --- /dev/null +++ b/sources/Interop/Windows/DirectX/shared/d3d9caps/D3DVSHADERCAPS2_0.xml @@ -0,0 +1,20 @@ + + + + + + Vertex shader caps. + + + Instruction predication is supported if this value is nonzero. See setp_comp - vs. + + + Either 0 or 24, which represents the depth of the dynamic flow control instruction nesting. See D3DVS20CAPS. + + + The number of temporary registers supported. See D3DVS20CAPS. + + + The depth of nesting of the loop - vs/rep - vs and call - vs/callnz bool - vs instructions. See D3DVS20CAPS. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_BUFFER_TENSOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_BUFFER_TENSOR_DESC.xml index b579d1f5f9..a7ffb32dc9 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_BUFFER_TENSOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_BUFFER_TENSOR_DESC.xml @@ -12,14 +12,14 @@ Specifies additional options for the tensor. - The number of dimensions of the tensor. This member determines the size of the Sizes and Strides arrays (if provided). In DirectML, all buffer tensors must have a DimensionCount of either 4 or 5. Not all operators support a DimensionCount of 5. + The number of dimensions of the tensor. This member determines the size of the Sizes and Strides arrays (if provided). In DirectML, the dimension count may range from 1 up to 8, depending on the operator. Most operators support at least 4 dimensions. - The size, in elements, of each dimension in the tensor. Specifying a size of zero in any dimension is invalid, and will result in an error. The Sizes member is always specified in the order {N, C, H, W} if DimensionCount is 4, and {N, C, D, H, W} if DimensionCount is 5. + The size, in elements, of each dimension in the tensor. Specifying a size of zero in any dimension is invalid, and will result in an error. For operators where the axes have semantic meaning (for example, batch, channel, depth, height, width), the Sizes member is always specified in the order {N, C, H, W} if DimensionCount is 4, and {N, C, D, H, W} if DimensionCount is 5. Otherwise, the dimensions generally have no particular meaning. - Optional. Determines the number of elements (not bytes) to linearly traverse in order to reach the next element in that dimension. For example, a stride of 5 in dimension 1 means that the distance between elements (n) and (n+1) in that dimension is 5 elements when traversing the buffer linearly. The Strides member is always specified in the order {N, C, H, W} if DimensionCount is 4, and {N, C, D, H, W} if DimensionCount is 5. + Optional. Determines the number of elements (not bytes) to linearly traverse in order to reach the next element in that dimension. For example, a stride of 5 in dimension 1 means that the distance between elements (n) and (n+1) in that dimension is 5 elements when traversing the buffer linearly. For operators where the axes have semantic meaning (for example, batch, channel, depth, height, width), the Strides member is always specified in the order {N, C, H, W} if DimensionCount is 4, and {N, C, D, H, W} if DimensionCount is 5. Strides can be used to express broadcasting (by specifying a stride of 0) as well as padding (for example, by using a stride larger than the physical size of a row, to pad the end of a row). If Strides is not specified, each dimension in the tensor is considered to be contiguously packed, with no additional padding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_BIT_SHIFT_LEFT_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_BIT_SHIFT_LEFT_OPERATOR_DESC.xml index 8516a0e68e..6eed927379 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_BIT_SHIFT_LEFT_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_BIT_SHIFT_LEFT_OPERATOR_DESC.xml @@ -7,7 +7,7 @@ Performs a logical left shift of each element of ATensor by a number of bits given by the corresponding element of BTensor, placing the result into the corresponding element of OutputTensor. f(a, b) = (a << b) The bitwise operation is applied to tensor data in its native encoding. Therefore, the tensor data type is ignored except for determining the width of each element. - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_BIT_SHIFT_RIGHT_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_BIT_SHIFT_RIGHT_OPERATOR_DESC.xml index c93563f5ad..7ce9ff122e 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_BIT_SHIFT_RIGHT_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_BIT_SHIFT_RIGHT_OPERATOR_DESC.xml @@ -7,7 +7,7 @@ Performs a logical right shift of each element of ATensor by a number of bits given by the corresponding element of BTensor, placing the result into the corresponding element of OutputTensor. f(a, b) = (a >> b) The bitwise operation is applied to tensor data in its native encoding. Therefore, the tensor data type is ignored except for determining the width of each element. - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_DIVIDE_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_DIVIDE_OPERATOR_DESC.xml index 780c14374e..873a79b48e 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_DIVIDE_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_DIVIDE_OPERATOR_DESC.xml @@ -7,7 +7,7 @@ Computes the quotient of each element of ATensor over the corresponding element of BTensor, placing the result into the corresponding element of OutputTensor. f(a, b) = a / b For integer divisions, the result is truncated. - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_AND_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_AND_OPERATOR_DESC.xml index bef2ed4231..60bcac267c 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_AND_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_AND_OPERATOR_DESC.xml @@ -6,7 +6,7 @@ Performs a logical AND on each pair of corresponding elements of the input tensors, placing the result (1 for true, 0 for false) into the corresponding element of OutputTensor. f(a, b) = (a && b) - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_OR_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_OR_OPERATOR_DESC.xml index 650830927b..746ba3759f 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_OR_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_OR_OPERATOR_DESC.xml @@ -6,7 +6,7 @@ Performs a logical OR on each pair of corresponding elements of the input tensors, placing the result into the corresponding element of OutputTensor. f(a, b) = (a || b) - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_XOR_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_XOR_OPERATOR_DESC.xml index 86ed61d896..99cf655f3d 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_XOR_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_LOGICAL_XOR_OPERATOR_DESC.xml @@ -6,7 +6,7 @@ Performs a logical XOR (exclusive or) on each pair of corresponding elements of the input tensors, placing the result into the corresponding element of OutputTensor. f(a, b) = (!!a) != (!!b) - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MAX_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MAX_OPERATOR_DESC.xml index ec1fec6654..cfe2288c69 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MAX_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MAX_OPERATOR_DESC.xml @@ -6,7 +6,7 @@ Takes the greater of two corresponding elements from the input tensors, and places the result into the corresponding element of the output tensor. f(a, b) = max(a, b) - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MEAN_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MEAN_OPERATOR_DESC.xml index 49f818e3a4..47752d4162 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MEAN_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MEAN_OPERATOR_DESC.xml @@ -6,7 +6,7 @@ Averages each pair of corresponding elements of the input tensors, placing the result into the corresponding element of OutputTensor. f(a, b) = (a + b) / 2 - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MIN_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MIN_OPERATOR_DESC.xml index c897b4aa24..b1e2c716f9 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MIN_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MIN_OPERATOR_DESC.xml @@ -6,7 +6,7 @@ Takes the lesser of two corresponding elements from the input tensors, and places the result into the corresponding element of OutputTensor. f(a, b) = min(a, b) - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MODULUS_FLOOR_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MODULUS_FLOOR_OPERATOR_DESC.xml index 96413b3b0e..8909b66bb4 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MODULUS_FLOOR_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MODULUS_FLOOR_OPERATOR_DESC.xml @@ -7,7 +7,7 @@ Computes the modulus, with the same results as the Python modulus, for each pair of corresponding elements from the input tensors, placing the result into the corresponding element of OutputTensor. Because the quotient is rounded towards -inf, the result will have the same sign as the divisor. f(a, b) = a - (b * floor(a / b)) - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MODULUS_TRUNCATE_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MODULUS_TRUNCATE_OPERATOR_DESC.xml index accdd7a60c..e21ec78a0d 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MODULUS_TRUNCATE_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MODULUS_TRUNCATE_OPERATOR_DESC.xml @@ -7,7 +7,7 @@ Computes the C modulus operator for each pair of corresponding elements of the input tensors, placing the result into the corresponding element of OutputTensor. Because the quotient is rounded towards 0, the result will have the same sign as the dividend. f(a, b) = a - (b * trunc(a / b)) - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MULTIPLY_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MULTIPLY_OPERATOR_DESC.xml index 5a61435ee9..4923a2698a 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MULTIPLY_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_MULTIPLY_OPERATOR_DESC.xml @@ -6,7 +6,7 @@ Computes the product of each pair of corresponding elements of the input tensors, placing the result into the corresponding element of OutputTensor. f(a, b) = a * b - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_SUBTRACT_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_SUBTRACT_OPERATOR_DESC.xml index 80e44da3ba..567e0e7582 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_SUBTRACT_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_ELEMENT_WISE_SUBTRACT_OPERATOR_DESC.xml @@ -6,7 +6,7 @@ Subtracts each element of BTensor from the corresponding element of ATensor, placing the result into the corresponding element of OutputTensor. f(a, b) = a - b - This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the the input tensors during binding. + This operator supports in-place execution, meaning that OutputTensor is permitted to alias one of the input tensors during binding. diff --git a/sources/Interop/Windows/DirectX/um/DirectML/DML_GATHER_OPERATOR_DESC.xml b/sources/Interop/Windows/DirectX/um/DirectML/DML_GATHER_OPERATOR_DESC.xml index c2d7b5a4c0..bc60e0e9ab 100644 --- a/sources/Interop/Windows/DirectX/um/DirectML/DML_GATHER_OPERATOR_DESC.xml +++ b/sources/Interop/Windows/DirectX/um/DirectML/DML_GATHER_OPERATOR_DESC.xml @@ -15,6 +15,7 @@ A tensor containing the indices. The DimensionCount of this tensor must match InputTensor.DimensionCount. Starting with DML_FEATURE_LEVEL_3_0, this operator supports negative index values when using a signed integral type with this tensor. Negative indices are interpreted as being relative to the end of the axis dimension. For example, an index of -1 refers to the last element along that dimension. + Invalid indices will yield incorrect outputs, but no failure will occur, and all reads will be clamped safely within the input tensor's memory. diff --git a/sources/Interop/Windows/DirectX/um/Xinput/DirectX.xml b/sources/Interop/Windows/DirectX/um/Xinput/DirectX.xml index d576198905..3829eee2d4 100644 --- a/sources/Interop/Windows/DirectX/um/Xinput/DirectX.xml +++ b/sources/Interop/Windows/DirectX/um/Xinput/DirectX.xml @@ -41,7 +41,7 @@ XINPUT_FLAG_GAMEPAD - Limit query to devices of Xbox 360 Controller type. + Limit query to devices of controller type.  Any value of dwflags other than the above or 0 is illegal and will result in an error break when debugging. Pointer to an structure that receives the controller capabilities. diff --git a/sources/Interop/Windows/DirectX/um/Xinput/XINPUT_GAMEPAD.xml b/sources/Interop/Windows/DirectX/um/Xinput/XINPUT_GAMEPAD.xml index 399eb96860..bd88c32e84 100644 --- a/sources/Interop/Windows/DirectX/um/Xinput/XINPUT_GAMEPAD.xml +++ b/sources/Interop/Windows/DirectX/um/Xinput/XINPUT_GAMEPAD.xml @@ -3,7 +3,7 @@ - Describes the current state of the Xbox 360 Controller. + Describes the current state of the controller. diff --git a/sources/Interop/Windows/DirectX/um/Xinput/XINPUT_STATE.xml b/sources/Interop/Windows/DirectX/um/Xinput/XINPUT_STATE.xml index 64d7d8c7db..f56d1a0ec3 100644 --- a/sources/Interop/Windows/DirectX/um/Xinput/XINPUT_STATE.xml +++ b/sources/Interop/Windows/DirectX/um/Xinput/XINPUT_STATE.xml @@ -10,6 +10,6 @@ - structure containing the current state of an Xbox 360 Controller. + structure containing the current state of a controller. \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/d2d1/D2D1_RENDER_TARGET_PROPERTIES.xml b/sources/Interop/Windows/DirectX/um/d2d1/D2D1_RENDER_TARGET_PROPERTIES.xml index 2746dbb586..a1fd7e7494 100644 --- a/sources/Interop/Windows/DirectX/um/d2d1/D2D1_RENDER_TARGET_PROPERTIES.xml +++ b/sources/Interop/Windows/DirectX/um/d2d1/D2D1_RENDER_TARGET_PROPERTIES.xml @@ -21,6 +21,6 @@ A value that specifies how the render target is remoted and whether it should be GDI-compatible. Set to to create a render target that is not compatible with GDI and uses Direct3D command-stream remoting if it is available. - A value that specifies the minimum Direct3D feature level required for hardware rendering. If the specified minimum level is not available, the render target uses software rendering if the type member is set to ; if type is set to to D2D1_RENDER_TARGET_TYPE_HARDWARE, render target creation fails. A value of indicates that Direct2D should determine whether the Direct3D feature level of the device is adequate. This field is used only when creating and objects. + A value that specifies the minimum Direct3D feature level required for hardware rendering. If the specified minimum level is not available, the render target uses software rendering if the type member is set to ; if type is set to D2D1_RENDER_TARGET_TYPE_HARDWARE, render target creation fails. A value of indicates that Direct2D should determine whether the Direct3D feature level of the device is adequate. This field is used only when creating and objects. \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Device7.xml b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Device7.xml new file mode 100644 index 0000000000..0363cb73a9 --- /dev/null +++ b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Device7.xml @@ -0,0 +1,13 @@ + + + + + + Creates a new device context with no initially assigned target. + Options for creating the device context. + The created device context. + + + Represents a resource domain whose objects and device contexts can be used together. + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1DeviceContext7.xml b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1DeviceContext7.xml new file mode 100644 index 0000000000..b582637b9e --- /dev/null +++ b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1DeviceContext7.xml @@ -0,0 +1,34 @@ + + + + + + Draws a glyph run, using color representations of glyphs if available in the font. We recommended that you render color glyphs by using this method. + The baseline. + The glyph run to draw. + A description of the glyph run to draw. + Foreground brush for the text. + The glyph style. + Zero-based index of the font-defined color palette to use. + Specifies measuring mode for positioning glyphs in the run. + Snap options. + + + To support COLR v1, draws a color glyph run that has the format of . + The baseline. + The glyph run to draw. + Default fill brush. + The index used to select a color palette within a color font. Note that this not the same as the paletteIndex in the struct, which is not relevant for paint glyphs. + Specifies measuring mode for positioning glyphs in the run. + + + Retrieves the maximum paint feature level supported by . + The paint feature level supported by . + + + + Enables creation and drawing of geometry realization objects; extends earlier device context interfaces with support for advanced color fonts. + The ID2D1DeviceContext7 interface derives from . + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Factory7.xml b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Factory7.xml index 5c4f2b3fb7..aba3c2b85a 100644 --- a/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Factory7.xml +++ b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Factory7.xml @@ -3,7 +3,7 @@ - Creates a new Direct2D device from the given IDXGIDevice + Creates a new Direct2D device from the given IDXGIDevice. The IDXGIDevice from which to create the Direct2D device. The created device. This method returns an HRESULT success or error code. diff --git a/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Factory8.xml b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Factory8.xml new file mode 100644 index 0000000000..1330d44734 --- /dev/null +++ b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1Factory8.xml @@ -0,0 +1,16 @@ + + + + + + Creates a new Direct2D device from the given IDXGIDevice. + The IDXGIDevice from which to create the Direct2D device. + The created device. + + + + Creates Direct2D resources. This interface also enables the creation of objects. + The ID2D1Factory8 interface derives from . + + + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1SvgGlyphStyle.xml b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1SvgGlyphStyle.xml index 68091385ee..ccdc7e403b 100644 --- a/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1SvgGlyphStyle.xml +++ b/sources/Interop/Windows/DirectX/um/d2d1_3/ID2D1SvgGlyphStyle.xml @@ -11,7 +11,7 @@ Describes how the stroke is painted. The 'context-value' for the 'stroke-width' property. The 'context-value' for the 'stroke-dasharray' property. - The the number of dashes in the dash array. + The number of dashes in the dash array. The 'context-value' for the 'stroke-dashoffset' property. @@ -28,7 +28,7 @@ Describes how the stroke is painted. A null brush will cause the context-stroke value to be none. Specifies the 'context-value' for the 'stroke-width' property. Specifies the 'context-value' for the 'stroke-dasharray' property. A null value will cause the stroke-dasharray to be set to 'none'. - The the number of dashes in the dash array. + The number of dashes in the dash array. Specifies the 'context-value' for the 'stroke-dashoffset' property. This method returns an HRESULT success or error code. diff --git a/sources/Interop/Windows/DirectX/um/d2d1effectauthor/D2D1_PIXEL_OPTIONS.xml b/sources/Interop/Windows/DirectX/um/d2d1effectauthor/D2D1_PIXEL_OPTIONS.xml index 3f292b42ce..d55e2005b4 100644 --- a/sources/Interop/Windows/DirectX/um/d2d1effectauthor/D2D1_PIXEL_OPTIONS.xml +++ b/sources/Interop/Windows/DirectX/um/d2d1effectauthor/D2D1_PIXEL_OPTIONS.xml @@ -3,7 +3,7 @@ - Indicates how pixel shader sampling will be restricted. This indicates whether the vertex buffer is large and tends to change infrequently or smaller and changes frequently (typically frame over frame). + Indicates how pixel shader sampling will be restricted. The pixel shader is not restricted in its sampling. diff --git a/sources/Interop/Windows/DirectX/um/d3d11shader/ID3D11ShaderReflection.xml b/sources/Interop/Windows/DirectX/um/d3d11shader/ID3D11ShaderReflection.xml index d08b35617d..5b66962230 100644 --- a/sources/Interop/Windows/DirectX/um/d3d11shader/ID3D11ShaderReflection.xml +++ b/sources/Interop/Windows/DirectX/um/d3d11shader/ID3D11ShaderReflection.xml @@ -37,7 +37,7 @@ Gets the minimum feature level. - A pointer to one of the enumerated values in , which represents the minimum feature level. + A pointer to one of the enumerated values in , which represents the minimum feature level. Returns one of the following Direct3D 11 Return Codes. diff --git a/sources/Interop/Windows/DirectX/um/dcommon/DWRITE_GLYPH_IMAGE_FORMATS.xml b/sources/Interop/Windows/DirectX/um/dcommon/DWRITE_GLYPH_IMAGE_FORMATS.xml index f5b3ec4e53..94ade126a4 100644 --- a/sources/Interop/Windows/DirectX/um/dcommon/DWRITE_GLYPH_IMAGE_FORMATS.xml +++ b/sources/Interop/Windows/DirectX/um/dcommon/DWRITE_GLYPH_IMAGE_FORMATS.xml @@ -3,33 +3,43 @@ - Specifies which formats are supported in the font, either at a font-wide level or per glyph. + +
[!NOTE]Some information relates to pre-released product, which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
+ Defines constants that specify which formats are supported in a font, either at a font-wide level or per glyph. + For color fonts, these formats can be used to represent color glyphs. Fonts can contain multiple drawable data formats for glyphs. And an app can use these values to tell DirectWrite which formats to return when splitting a color glyph run. + - Indicates no data is available for this glyph. + Specifies that no data is available for this glyph. - The glyph has TrueType outlines. + Specifies that the glyph has TrueType outlines. - The glyph has CFF outlines. + Specifies that the glyph has CFF outlines. - The glyph has multilayered COLR data. + Specifies that the glyph has multilayered COLR data. - The glyph has SVG outlines as standard XML. Fonts may store the content gzip'd rather than plain text, indicated by the first two bytes as gzip header {0x1F 0x8B}. + Specifies that the glyph has SVG outlines as standard XML. Fonts may store the content gzip'd rather than plain text, indicated by the first two bytes as gzip header {0x1F 0x8B}. - The glyph has PNG image data, with standard PNG IHDR. + Specifies that the glyph has PNG image data, with standard PNG IHDR. - The glyph has JPEG image data, with standard JIFF SOI header. + Specifies that the glyph has JPEG image data, with standard JIFF SOI header. - The glyph has TIFF image data. + Specifies that the glyph has TIFF image data. - The glyph has raw 32-bit premultiplied BGRA data. + Specifies that the glyph has raw 32-bit premultiplied BGRA data. + + + +
[!IMPORTANT] The DWRITE_GLYPH_IMAGE_FORMATS_COLR_PAINT_TREE constant is available in pre-release versions of the Windows Insider Preview.
+ Specifies that the glyph is represented by a tree of paint elements in the font's COLR table. + \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionDevice.xml b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionDevice.xml index 3839cec870..571847ee8b 100644 --- a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionDevice.xml +++ b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionDevice.xml @@ -68,48 +68,7 @@ The pixel format of the surface. The format of the alpha channel, if an alpha channel is included in the pixel format. It can be one of the following values: - - - Value - Meaning - - - - - - - DXGI_ALPHA_MODE_UNSPECIFIED - - - - - The alpha channel is not specified. This value has the same effect as DXGI_ALPHA_MODE_IGNORE. - - - - - - - DXGI_ALPHA_MODE_PREMULTIPLIED - - - - - The color channels contain values that are premultiplied with the alpha channel. - - - - - - - DXGI_ALPHA_MODE_IGNORE - - - - - The alpha channel should be ignored and the bitmap should be rendered opaquely. - - + | Value | Meaning | | - | - | | DXGI_ALPHA_MODE_UNSPECIFIED | The alpha channel isn't specified. This value has the same effect as DXGI_ALPHA_MODE_IGNORE. | | DXGI_ALPHA_MODE_PREMULTIPLIED | The color channels contain values that are premultiplied with the alpha channel. | | DXGI_ALPHA_MODE_IGNORE | The alpha channel should be ignored, and the bitmap should be rendered opaquely. | The newly created surface object. This parameter must not be NULL. If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See DirectComposition Error Codes for a list of error codes. diff --git a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionDevice4.xml b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionDevice4.xml index b2ce618a4f..e55e93c4de 100644 --- a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionDevice4.xml +++ b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionDevice4.xml @@ -3,7 +3,10 @@ - Queries whether the Direct3D device that you're using to render supports composition textures (without having to first allocate a Direct3D texture on that device). Before you attempt to create composition textures for Direct3D textures backed by a given Direct3D device, you should call CheckCompositionTextureSupport, passing that backing device. + + Queries whether the Direct3D device that you're using to render supports composition textures (without having to first allocate a Direct3D texture on that device). Before you attempt to create composition textures for Direct3D textures backed by a given Direct3D device, you should call CheckCompositionTextureSupport, passing that backing device. + Generally speaking, a rendering device that reports support for monitored fences via is able to support composition textures. But in rare cases, the operating system (OS) itself can disable the composition textures feature; in which case CheckCompositionTextureSupport will also report unsupported. + The backing Direct3D device. Points to a value of true if renderingDevice supports composition textures; otherwise 'false`. If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. diff --git a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionFilterEffect.xml b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionFilterEffect.xml index 658d94024c..12e9cbbb51 100644 --- a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionFilterEffect.xml +++ b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionFilterEffect.xml @@ -3,7 +3,7 @@ - Sets the the input at an index to the specified filter effect. + Sets the input at an index to the specified filter effect. Specifies the index the to apply the filter effect at. The filter effect to apply. The following effects are available: diff --git a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionLinearTransferEffect.xml b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionLinearTransferEffect.xml index 42c92c6258..ef0ef09989 100644 --- a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionLinearTransferEffect.xml +++ b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionLinearTransferEffect.xml @@ -24,7 +24,7 @@ Sets the Y-intercept of the linear function for the Alpha channel. - An animation that represents how the the Y-intercept of the linear function for the alpha channel. changes over time. This parameter must not be NULL. + An animation that represents how the Y-intercept of the linear function for the alpha channel. changes over time. This parameter must not be NULL. If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. diff --git a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionTexture.xml b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionTexture.xml index 9e11a74d0e..145eb05469 100644 --- a/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionTexture.xml +++ b/sources/Interop/Windows/DirectX/um/dcomp/IDCompositionTexture.xml @@ -6,6 +6,7 @@ Retrieves a Direct3D synchronization fence/value pair that indicates when the composition texture will become available, if that info is known. The value returned depends on the availability state of the composition texture. An availability state specifies whether, and when, it's safe to render to the composition texture. See the Remarks section for the availability states, their descriptions, and how GetAvailableFence behaves for each state. + If a composition texture becomes available, then your app must be careful to issue rendering only to the exact subregion of the Direct3D texture that it refers to. The returned fence value. An interface identifier. @@ -13,13 +14,16 @@ If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. - TBD - TBD + Informs the Desktop Window Manager (DWM) whether alpha pixels in the texture should be honored or ignored. + + Indicates whether alpha pixels in the texture should be honored or ignored. + | Value | Meaning | | - | - | | DXGI_ALPHA_MODE_UNSPECIFIED | The alpha channel isn't specified. This value has the same effect as DXGI_ALPHA_MODE_IGNORE. | | DXGI_ALPHA_MODE_PREMULTIPLIED | The color channels contain values that are premultiplied with the alpha channel. | | DXGI_ALPHA_MODE_IGNORE | The alpha channel should be ignored, and the bitmap should be rendered opaquely. | + If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. - TBD - TBD + Informs the system of the color space that it should map the texture into. + Specifies the color space to use. If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. @@ -29,7 +33,7 @@ - The interface to an object that represents a raw Direct3D texture that can be bound to a DComp visual as content. The object can be used anywhere that a generic composition surface can be used in those APIs today—for example, as the content of a visual or a surface brush. The object exposes an available fence, which can be used to synchronize application rendering and composition work. Can also accept various attributes, such as an alpha mode, source rect, and color space, to more precisely define the content being displayed. + The interface to an object that represents a raw Direct3D texture that can be bound to a composition visual as content. The object can be used anywhere that a generic composition surface can be used in those APIs today—for example, as the content of a sprite visual or a surface brush. The object exposes an available fence, which can be used to synchronize application rendering and composition work. Can also accept various attributes, such as an alpha mode, source rect, and color space, to more precisely define the content being displayed. The composition textures API supports Direct3D 11 only. diff --git a/sources/Interop/Windows/DirectX/um/dwrite/DWRITE_LINE_SPACING_METHOD.xml b/sources/Interop/Windows/DirectX/um/dwrite/DWRITE_LINE_SPACING_METHOD.xml index 5dce7fc1b5..ddc6ac7521 100644 --- a/sources/Interop/Windows/DirectX/um/dwrite/DWRITE_LINE_SPACING_METHOD.xml +++ b/sources/Interop/Windows/DirectX/um/dwrite/DWRITE_LINE_SPACING_METHOD.xml @@ -14,8 +14,7 @@ Line spacing and baseline distances are proportional to the computed values based on the content, the size of the fonts and inline objects. -
- Note  This value is only available on Windows 10 or later and it can be used with IDWriteTextLayout3.SetLineSpacing, but can not be used with .
+
[!NOTE] This value is available only on Windows 10 or later, and it can be used with , but it can't be used with .
 \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/dwrite/DWRITE_TRIMMING.xml b/sources/Interop/Windows/DirectX/um/dwrite/DWRITE_TRIMMING.xml index e449d74acd..ff206d0b13 100644 --- a/sources/Interop/Windows/DirectX/um/dwrite/DWRITE_TRIMMING.xml +++ b/sources/Interop/Windows/DirectX/um/dwrite/DWRITE_TRIMMING.xml @@ -9,7 +9,10 @@ A value that specifies the text granularity used to trim text overflowing the layout box. - A character code used as the delimiter that signals the beginning of the portion of text to be preserved. Text starting from the Nth occurrence of the delimiter (where N equals delimiterCount) counting backwards from the end of the text block will be preserved. For example, given the text is a path like c:\A\B\C\D\file.txt and delimiter equal to '' and delimiterCount equal to 1, the file.txt portion of the text would be preserved.
Specifying a delimiterCount of 2 would preserve D\file.txt. + + A character code used as the delimiter that signals the beginning of the portion of text to be preserved. + Text starting from the Nth occurrence of the delimiter (where N equals delimiterCount) counting backwards from the end of the text block will be preserved. For example, if the text is the path C:\w\x\y\z\file.txt, and delimiter is equal to '\', and delimiterCount is equal to 1, then the file.txt portion of the path would be preserved. Specifying a delimiterCount of 2 would preserve z\file.txt. + The delimiter count, counting from the end of the text, to preserve text from. diff --git a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFactory2.xml b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFactory2.xml index 8a20d25fbb..8603644bb8 100644 --- a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFactory2.xml +++ b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFactory2.xml @@ -49,7 +49,7 @@ Measuring mode used to compute glyph positions if the run contains color glyphs. World transform multiplied by any DPI scaling. This is needed to compute glyph positions if the run contains color glyphs and the measuring mode is not . If this parameter is NULL, and identity transform is assumed. Zero-based index of the color palette to use. Valid indices are less than the number of palettes in the font, as returned by . - If the original glyph run contains color glyphs, this parameter receives a pointer to an IDWriteColorGlyphRunEnumerator interface. The client uses the returned interface to get information about glyph runs and associated colors to render instead of the original glyph run. If the original glyph run does not contain color glyphs, this method returns DWRITE_E_NOCOLOR and the output pointer is NULL. + If the original glyph run contains color glyphs, this parameter receives a pointer to an interface. The client uses the returned interface to get information about glyph runs and associated colors to render instead of the original glyph run. If the original glyph run does not contain color glyphs, this method returns DWRITE_E_NOCOLOR and the output pointer is NULL. If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFont2.xml b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFont2.xml index fab74e5144..ae7b8865b7 100644 --- a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFont2.xml +++ b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFont2.xml @@ -3,7 +3,7 @@ - Enables determining if a color rendering path is potentially necessary. + Enables determining whether a color rendering path is potentially necessary. Returns TRUE if the font has color information (COLR and CPAL tables); otherwise FALSE. diff --git a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFontFallback.xml b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFontFallback.xml index a264a399a0..1b3755c35c 100644 --- a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFontFallback.xml +++ b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteFontFallback.xml @@ -20,7 +20,7 @@ Allows you to access fallback fonts from the font list. - The IDWriteFontFallback interface defines a fallback sequence to map character ranges to fonts, which is either created via IDWriteFontFallbackBuilder or retrieved from IDWriteFactory2.GetSystemFontFallback. + The IDWriteFontFallback interface defines a fallback sequence to map character ranges to fonts, which is either created via or retrieved from . \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteTextFormat1.xml b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteTextFormat1.xml index 196d7c472d..1ff88415b2 100644 --- a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteTextFormat1.xml +++ b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteTextFormat1.xml @@ -4,7 +4,7 @@ Gets the current fallback. If none was ever set since creating the layout, it will be nullptr. - Contains an address of a pointer to the the current font fallback object. + Contains an address of a pointer to the current font fallback object. If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. diff --git a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteTextLayout2.xml b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteTextLayout2.xml index 118e8b030a..df366ee422 100644 --- a/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteTextLayout2.xml +++ b/sources/Interop/Windows/DirectX/um/dwrite_2/IDWriteTextLayout2.xml @@ -23,7 +23,7 @@ Apply a custom font fallback onto layout. If none is specified, the layout uses the system fallback list. - Custom font fallback created from or IDWriteFactory2.GetSystemFontFallback. + Custom font fallback created from or . If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. diff --git a/sources/Interop/Windows/DirectX/um/dwrite_3/IDWriteTextFormat3.xml b/sources/Interop/Windows/DirectX/um/dwrite_3/IDWriteTextFormat3.xml index 1fc6ce509d..cf8aa4b70c 100644 --- a/sources/Interop/Windows/DirectX/um/dwrite_3/IDWriteTextFormat3.xml +++ b/sources/Interop/Windows/DirectX/um/dwrite_3/IDWriteTextFormat3.xml @@ -30,7 +30,7 @@ Describes the font and paragraph properties used to format text, and it describes locale information. - This interface extends IDWriteTextFormat2. + This interface extends . \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/dxcapi/DxcShaderHash.xml b/sources/Interop/Windows/DirectX/um/dxcapi/DxcShaderHash.xml index 95b35ee6f3..7153bfa975 100644 --- a/sources/Interop/Windows/DirectX/um/dxcapi/DxcShaderHash.xml +++ b/sources/Interop/Windows/DirectX/um/dxcapi/DxcShaderHash.xml @@ -8,7 +8,7 @@ One of DXC_HASHFLAG_Xxx. - + The hash digest. \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreAdapterMemoryBudget.xml b/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreAdapterMemoryBudget.xml index e5a5cadd67..36357565ca 100644 --- a/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreAdapterMemoryBudget.xml +++ b/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreAdapterMemoryBudget.xml @@ -8,13 +8,13 @@ Specifies the OS-provided adapter memory budget, in bytes, that your application should target. If currentUsage is greater than budget, then your application may incur stuttering or performance penalties due to background activity by the OS, which is intended to provide other applications with a fair usage of adapter memory. - + Specifies your application's current adapter memory usage, in bytes. Specifies the amount of adapter memory, in bytes, that your application has available for reservation. To reserve this adapter memory, your application should call IDXCoreAdapter.SetState with state set to . - + Specifies the amount of adapter memory, in bytes, that is reserved by your application. The OS uses the reservation as a hint to determine your application's minimum working set. Your application should attempt to ensure that its adapter memory usage can be trimmed to meet this requirement. \ No newline at end of file diff --git a/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreHardwareID.xml b/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreHardwareID.xml index e9a394659e..b1fce90f4a 100644 --- a/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreHardwareID.xml +++ b/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreHardwareID.xml @@ -5,13 +5,13 @@ Represents the PnP hardware ID parts for an adapter. - + The PCI ID of the adapter's hardware vendor. - + The PCI ID of the adapter's hardware device. - + The PCI ID of the adapter's hardware subsystem. diff --git a/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreNotificationType.xml b/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreNotificationType.xml index 0d9a63c8f1..0d155f4aea 100644 --- a/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreNotificationType.xml +++ b/sources/Interop/Windows/DirectX/um/dxcore_interface/DXCoreNotificationType.xml @@ -4,7 +4,7 @@ - Defines constants that specify types of notifications raised by or IDXCoreAdapterList objects. + Defines constants that specify types of notifications raised by IDXCoreAdapter or IDXCoreAdapterList objects. You can register and unregister for these notifications by calling IDXCoreAdapterFactory.RegisterEventNotification and IDXCoreAdapterFactory.UnregisterEventNotification, respectively. diff --git a/sources/Interop/Windows/DirectX/um/dxcore_interface/IDXCoreAdapterFactory.xml b/sources/Interop/Windows/DirectX/um/dxcore_interface/IDXCoreAdapterFactory.xml index 8204597e2e..098dfbb740 100644 --- a/sources/Interop/Windows/DirectX/um/dxcore_interface/IDXCoreAdapterFactory.xml +++ b/sources/Interop/Windows/DirectX/um/dxcore_interface/IDXCoreAdapterFactory.xml @@ -7,7 +7,7 @@ The number of elements in the array pointed to by the filterAttributes argument. A pointer to an array of adapter attribute GUIDs. For a list of attribute GUIDs, see DXCore adapter attribute GUIDs. At least one GUID must be provided. In the case that more than one GUID is provided in the array, only adapters that meet all of the requested attributes will be included in the returned list. A reference to the globally unique identifier (GUID) of the interface that you wish to be returned in ppvAdapterList. This is expected to be the interface identifier (IID) of . - The address of a pointer to an interface with the IID specified in the riid parameter. Upon successful return, *ppvAdapterList (the dereferenced address) contains a pointer to the the adapter list created. + The address of a pointer to an interface with the IID specified in the riid parameter. Upon successful return, *ppvAdapterList (the dereferenced address) contains a pointer to the adapter list created. If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULTerror code. |Return value|Description| |-|-| |E_INVALIDARG|nullptr was provided for filterAttributes, or 0 was provided for numAttributes.| |E_NOINTERFACE|An invalid value was provided for riid.| |E_POINTER|nullptr was provided for ppvAdapterList.| @@ -17,7 +17,7 @@ Retrieves the DXCore adapter object () for a specified LUID, if available. For programming guidance, and code examples, see Using DXCore to enumerate adapters. The locally unique value that identifies the adapter instance. A reference to the globally unique identifier (GUID) of the interface that you wish to be returned in ppvAdapter. This is expected to be the interface identifier (IID) of . - The address of a pointer to an interface with the IID specified in the riid parameter. Upon successful return, *ppvAdapter (the dereferenced address) contains a pointer to the the DXCore adapter created. + The address of a pointer to an interface with the IID specified in the riid parameter. Upon successful return, *ppvAdapter (the dereferenced address) contains a pointer to the DXCore adapter created. If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULTerror code. |Return value|Description| |-|-| |DXGI_ERROR_DEVICE_REMOVED|The adapter LUID passed in adapterLUID is recognized, but the adapter is no longer in a valid state.| |E_INVALIDARG|No such adapter LUID as the value passed in adapterLUID is available through DXCore.| |E_NOINTERFACE|An invalid value was provided for riid.| |E_POINTER|nullptr was provided for ppvAdapter.| diff --git a/sources/Interop/Windows/DirectX/um/dxcore_interface/IDXCoreAdapterList.xml b/sources/Interop/Windows/DirectX/um/dxcore_interface/IDXCoreAdapterList.xml index fa86b23e17..86a76f6c99 100644 --- a/sources/Interop/Windows/DirectX/um/dxcore_interface/IDXCoreAdapterList.xml +++ b/sources/Interop/Windows/DirectX/um/dxcore_interface/IDXCoreAdapterList.xml @@ -6,7 +6,7 @@ Retrieves a specific adapter by index from a DXCore adapter list object. For programming guidance, and code examples, see Using DXCore to enumerate adapters. A zero-based index, identifying an adapter instance within the DXCore adapter list. A reference to the globally unique identifier (GUID) of the interface that you wish to be returned in ppvAdapter. This is expected to be the interface identifier (IID) of . - The address of a pointer to an interface with the IID specified in the riid parameter. Upon successful return, *ppvAdapter (the dereferenced address) contains a pointer to the the DXCore adapter created. + The address of a pointer to an interface with the IID specified in the riid parameter. Upon successful return, *ppvAdapter (the dereferenced address) contains a pointer to the DXCore adapter created. If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULTerror code. |Return value|Description| |-|-| |DXGI_ERROR_DEVICE_REMOVED|The index is valid, but the adapter is no longer in a valid state.| |E_INVALIDARG|The provided index is not valid.| |E_NOINTERFACE|An invalid value was provided for riid.| |E_POINTER|nullptr was provided for ppvAdapter.| @@ -27,7 +27,7 @@ Determines whether a specified value is understood by the current operating system (OS). You can call IsAdapterPreferenceSupported before calling . - A DXCoreAdapterPreference value that will be checked to see whether it's supported by the OS. + A value that will be checked to see whether it's supported by the OS. Returns true if the sort type is understood by the current OS. Otherwise, returns false. diff --git a/sources/Interop/Windows/Gdiplus/um/gdipluseffects/RedEyeCorrectionParams.xml b/sources/Interop/Windows/Gdiplus/um/gdipluseffects/RedEyeCorrectionParams.xml index 272736a42e..ea18e548e1 100644 --- a/sources/Interop/Windows/Gdiplus/um/gdipluseffects/RedEyeCorrectionParams.xml +++ b/sources/Interop/Windows/Gdiplus/um/gdipluseffects/RedEyeCorrectionParams.xml @@ -5,7 +5,7 @@ A RedEyeCorrectionParams structure contains members that specify the areas of a bitmap to which a red-eye correction is applied. - You can can correct red eyes in a bitmap by following these steps. + You can correct red eyes in a bitmap by following these steps. Create and initialize a RedEyeCorrectionParams structure. diff --git a/sources/Interop/Windows/WinRT/um/SystemMediaTransportControlsInterop/ISystemMediaTransportControlsInterop.xml b/sources/Interop/Windows/WinRT/um/SystemMediaTransportControlsInterop/ISystemMediaTransportControlsInterop.xml index d5a18d0254..8d592fe9e2 100644 --- a/sources/Interop/Windows/WinRT/um/SystemMediaTransportControlsInterop/ISystemMediaTransportControlsInterop.xml +++ b/sources/Interop/Windows/WinRT/um/SystemMediaTransportControlsInterop/ISystemMediaTransportControlsInterop.xml @@ -11,6 +11,7 @@ + [The feature associated with this page, Media Transport Controls, is a legacy feature. It has been superseded by System Media Transport Controls. System Media Transport Controls has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use System Media Transport Controls instead of #FEATURENAMENOLINK#, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Enables interoperability with a WinRT a SystemMediaTransportControls object. This interface is implemented by the Windows.Media.SystemMediaTransportControls activation factory. diff --git a/sources/Interop/Windows/WinRT/um/WindowsStorageCOM/HANDLE_CREATION_OPTIONS.xml b/sources/Interop/Windows/WinRT/um/WindowsStorageCOM/HANDLE_CREATION_OPTIONS.xml index 0e062c64f3..7a9b0f6a83 100644 --- a/sources/Interop/Windows/WinRT/um/WindowsStorageCOM/HANDLE_CREATION_OPTIONS.xml +++ b/sources/Interop/Windows/WinRT/um/WindowsStorageCOM/HANDLE_CREATION_OPTIONS.xml @@ -3,21 +3,21 @@ - Represents the action to take on a file that exists or doesn't exist. + Represents the action to take depending on whether the file already exists. - Create a new file, only if it doesn't already exist. + Create a new file. The operation fails if the file already exists. - Create a new file, always. + Create a new file. If the file already exists, then it is truncated so that its size is zero bytes. - Open a file only if it exists. + Open a file only if it exists. The operation fails if the file does not exist. - Open a file, always. + Open a file, creating it if it does not already exist. - Open a file and truncates it so that its size is zero bytes, only if it exists. + Open a file and truncates it so that its size is zero bytes. The operation fails if the file does not exist. \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/um/windows.graphics.directx.direct3d11.interop/WinRT.xml b/sources/Interop/Windows/WinRT/um/windows.graphics.directx.direct3d11.interop/WinRT.xml index f200db3c53..b87daf27be 100644 --- a/sources/Interop/Windows/WinRT/um/windows.graphics.directx.direct3d11.interop/WinRT.xml +++ b/sources/Interop/Windows/WinRT/um/windows.graphics.directx.direct3d11.interop/WinRT.xml @@ -17,7 +17,7 @@ Retrieves the DXGI interface that is wrapped by the IDirect3DDxgiInterfaceAccess object. A reference to the globally unique identifier (GUID) of the interface that you wish to be returned in p. - A pointer to a memory block that receives a pointer to the the DXGI interface. + A pointer to a memory block that receives a pointer to the DXGI interface. If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULTerror code. \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreInputInterop2.xml b/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreInputInterop2.xml new file mode 100644 index 0000000000..31d1f4ee4c --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreInputInterop2.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreWindowAdapterInterop.xml b/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreWindowAdapterInterop.xml new file mode 100644 index 0000000000..325d70e73c --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreWindowAdapterInterop.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreWindowComponentInterop.xml b/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreWindowComponentInterop.xml new file mode 100644 index 0000000000..f9fc68634f --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/CoreWindow/ICoreWindowComponentInterop.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/CoreWindow/WinRT.xml b/sources/Interop/Windows/WinRT/winrt/CoreWindow/WinRT.xml index b4a8a3bdde..f3a9b9df69 100644 --- a/sources/Interop/Windows/WinRT/winrt/CoreWindow/WinRT.xml +++ b/sources/Interop/Windows/WinRT/winrt/CoreWindow/WinRT.xml @@ -15,4 +15,12 @@ Pointer to receive the ICoreInputSourceBase object. If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/DateTime.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/DateTime.xml new file mode 100644 index 0000000000..4100d45e3e --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/DateTime.xml @@ -0,0 +1,12 @@ + + + + + + Represents an instant in time, typically expressed as a date and time of day. + + + + The number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight on January 1, 1601 CE, UTC time. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/IAsyncAction.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IAsyncAction.xml new file mode 100644 index 0000000000..7a513d7279 --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IAsyncAction.xml @@ -0,0 +1,8 @@ + + + + + + Represents an asynchronous action. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/IClosable.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IClosable.xml new file mode 100644 index 0000000000..426592cb0d --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IClosable.xml @@ -0,0 +1,12 @@ + + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting allocated resources. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Defines a method to release allocated resources. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/IPropertyValue.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IPropertyValue.xml new file mode 100644 index 0000000000..bf1eaaa220 --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IPropertyValue.xml @@ -0,0 +1,703 @@ + + + + + + Gets the 8-bit Boolean value that is stored in the current object. + The 8-bit Boolean value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the value of the property. + + + + + + Gets the array of 8-bit Boolean values that is stored in the current object. + The number of values in the array. + + The array of 8-bit Boolean values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the Unicode character that is stored in the current object. + The Unicode character. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the the array of Unicode characters that is stored in the current object. + The number of Unicode characters in the array. + + The array of Unicode characters. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the value that is stored in the current object. + The value. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the array of values that is stored in the current object. + The number of values in the array. + + The array of values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the 64-bit floating point value that is stored in the current object. + The 64-bit floating point value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the array of 64-bit floating point values that is stored in the current object. + The number of values in the array. + + The array of 64-bit floating point values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the GUID value that is stored in the current object. + The value. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the array of Guid values that is stored in the current object. + The number of values in the array. + + The array of Guid values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the array of pointers to objects that is stored in the current object. + The number of values in the array. + + The array of pointers to objects. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the signed 32-bit integer value that is stored in the current object. + The signed 32-bit integer value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the array of signed 32-bit integer values that is stored in the current object. + The number of values in the array. + + The array of signed 32-bit integer values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the signed 64-bit integer value that is stored in the current object. + The signed 64-bit integer value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the array of signed 64-bit integer values that is stored in the current object. + The number of values in the array. + + The array of signed 64-bit integer values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the value that is stored in the current object. + The value. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the array of values that is stored in the current object. + The number of values in the array. + + The array of values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the value that is stored in the current object. + The value. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the array of values that is stored in the current object. + The number of values in the array. + + The array of values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the 32-bit floating point value that is stored in the current object. + The 32-bit floating point value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the array of 32-bit floating point values that is stored in the current object. + The number of values in the array. + + The array of 32-bit floating point values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the value that is stored in the current object. + The value. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the array of values that is stored in the current object. + The number of values in the array. + + The array of values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the string value that is stored in the current object. + The string value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the array of string values that is stored in the current object. + The number of values in the array. + + The array of string values. + The returned strings must be freed using . The returned objects must be released using IUnknown.Release. + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the value that is stored in the current object. + The value. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the array of values that is stored in the current object. + The number of values in the array. + + The array of values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the unsigned 32-bit integer value that is stored in the current object. + The unsigned 32-bit integer value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the array of unsigned 32-bit integer values that is stored in the current object. + The number of values in the array. + + The array of unsigned 32-bit integer values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the unsigned 64-bit integer value that is stored in the current object. + The unsigned 64-bit integer value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the array of unsigned 64-bit integer values that is stored in the current object. + The number of values in the array. + + The array of unsigned 64-bit integer values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Gets the unsigned 8-bit integer value that is stored in the current object. + The unsigned 8-bit integer values. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was returned successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_INCORRECT_TYPE + + + + + The type of value does not match the property. + + + + + + Gets the array of unsigned 8-bit integer values that is stored in the current object. + The number of values in the array. + + The array of unsigned 8-bit integer values. + The returned pointer must be freed using . + + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + + Gets the data type of the value that is stored in the current object. + This property is read-only. + + + + + Gets the data type of the value that is stored in the current object. + This property is read-only. + + + + Represents a value in a Windows Runtime property store. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/IPropertyValueStatics.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IPropertyValueStatics.xml new file mode 100644 index 0000000000..da8b4c1d3f --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IPropertyValueStatics.xml @@ -0,0 +1,774 @@ + + + + + + Creates a new object that contains the specified 8-bit Boolean value. + The value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of 8-bit Boolean values. + The number of values in the array. + The array of 8-bit Boolean values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified Unicode character. + The Unicode character to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of Unicode characters. + The number of Unicode characters in the array. + The array of Unicode characters to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified value. + The value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified array of values. + The number of values in the array. + The array of values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified 64-bit floating point value. + The 64-bit floating point value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of 64-bit floating point values. + The number of values in the array. + The array of 64-bit floating point values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that represents an empty value. + A pointer to a new object that has its property set to PropertyType_Empty. No value is stored in the new object. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified GUID value. + The value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified array of Guid values. + The number of values in the array. + The array of Guid values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified object. + The object to store. + A pointer to a new object that contains value. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of objects. + The number of objects in the array. + The array of objects to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified signed 32-bit integer value. + The signed 32-bit integer value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of signed 32-bit integer values. + The number of values in the array. + The array of signed 32-bit integer values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified signed 64-bit integer value. + The signed 64-bit integer value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of signed 64-bit integer values. + The number of values in the array. + The array of signed 64-bit integer values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified value. + The value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified array of values. + The number of values in the array. + The array of values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified value. + The value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified array of values. + The number of values in the array. + The array of values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified 32-bit floating point value. + The 32-bit floating point value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of 32-bit floating point values. + The number of values in the array. + The array of 32-bit floating point values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified value. + The value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified array of values. + The number of values in the array. + The array of values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified string value. + The string value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of string values. + The number of values in the array. + The array of string values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified value. + The value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified array of values. + The number of values in the array. + The array of values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified unsigned 32-bit integer value. + The unsigned 32-bit integer value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of unsigned 32-bit integer values. + The number of values in the array. + The array of unsigned 32-bit integer values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified unsigned 64-bit integer value. + The unsigned 64-bit integer value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of unsigned 64-bit integer values. + The number of values in the array. + The array of unsigned 64-bit integer values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates a new object that contains the specified unsigned 8-bit integer value. + The unsigned 8-bit integer value to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + + This method can return one of these values. + + + Return code + Description + + + + + + + S_OK + + + + + The property value was created successfully. + + + + + + + E_POINTER + + + + + + value is NULL. + + + + + + + E_OUTOFMEMORY + + + + + The object could not be created. + + + + + + Creates a new object that contains the specified array of unsigned 8-bit integer values. + The number of values in the array. + The array of unsigned 8-bit integer values to store. + A pointer to a new object that contains value. Use the method to get the interface for the object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Creates objects that you can store in a property store. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/IStringable.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IStringable.xml new file mode 100644 index 0000000000..7fde16fede --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/IStringable.xml @@ -0,0 +1,13 @@ + + + + + + Gets a string that represents the current object. + A string representation of the current object. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + + + Provides a way to represent the current object as a string. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/Point.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/Point.xml new file mode 100644 index 0000000000..4a730f71b5 --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/Point.xml @@ -0,0 +1,16 @@ + + + + + + Represents an ordered pair of floating-point x- and y-coordinates that defines a point in a two-dimensional plane. + + + + + The horizontal position of the point. + + + The vertical position of the point. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/PropertyType.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/PropertyType.xml new file mode 100644 index 0000000000..e70c717e1e --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/PropertyType.xml @@ -0,0 +1,131 @@ + + + + + + Identifies the type that is stored in a Windows Runtime object that implements the interface. + + + The object does not contain a value. + + + The object contains an unsigned 8-bit integer. + + + The object contains a signed 16-bit integer. + + + The object contains an unsigned 16-bit integer. + + + The object contains a signed 32-bit integer. + + + The object contains an unsigned 32-bit integer. + + + The object contains a signed 64-bit integer. + + + The object contains an unsigned 64-bit integer. + + + The object contains a 32-bit floating point value. This value conforms to the IEEE 754 standard. + + + The object contains a 64-bit floating point value. This value conforms to the IEEE 754 standard. + + + The object contains a 16-bit character. This character represents a UTF-16 (Unicode) code unit. + + + The object contains an 8-bit Boolean value. + + + The object contains an HSTRING. + + + The object contains an object that implements the interface. + + + The object contains a . + + + The object contains a . + + + The object contains a GUID. + + + The object contains a . + + + The object contains a . + + + The object contains a . + + + The object contains an unspecified type. + + + The object contains an array of unsigned 8-bit integers. + + + The object contains an array of signed 16-bit integers. + + + The object contains an array of unsigned 16-bit integers. + + + The object contains an array of signed 32-bit integers. + + + The object contains an array of unsigned 32-bit integers. + + + The object contains an array of signed 64-bit integers. + + + The object contains an array of unsigned 64-bit integers. + + + The object contains an array of 32-bit floating point values. + + + The object contains an array of 64-bit floating point values. + + + The object contains an array of 16-bit characters. + + + The object contains an array of 8-bit Boolean values. + + + The object contains an array of HSTRING. + + + The object contains an array of objects that implement the interface. + + + The object contains an array of . + + + The object contains an array of . + + + The object contains an array of GUIDs. + + + The object contains an array of . + + + The object contains an array of . + + + The object contains an array of . + + + The object contains an array of an unspecified type. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/Rect.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/Rect.xml new file mode 100644 index 0000000000..4d4d875aeb --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/Rect.xml @@ -0,0 +1,24 @@ + + + + + + Contains a set of four floating-point numbers that represent the location and size of a rectangle. + + + + + + + The height of the rectangle. + + + The width of the rectangle. + + + The x-coordinate of the upper-left corner of the rectangle. + + + The y-coordinate of the upper-left corner of the rectangle. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/Size.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/Size.xml new file mode 100644 index 0000000000..40f8fd538c --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/Size.xml @@ -0,0 +1,16 @@ + + + + + + Represents an ordered pair of floating-point numbers that specify a height and width. + + + + + The height. + + + The width. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.foundation/TimeSpan.xml b/sources/Interop/Windows/WinRT/winrt/windows.foundation/TimeSpan.xml new file mode 100644 index 0000000000..bc7d1fe48f --- /dev/null +++ b/sources/Interop/Windows/WinRT/winrt/windows.foundation/TimeSpan.xml @@ -0,0 +1,12 @@ + + + + + + Represents a time interval. + + + + The time interval, in 100-nanosecond units. + + \ No newline at end of file diff --git a/sources/Interop/Windows/WinRT/winrt/windows.ui.composition.interop/ICompositionTextureInterop.xml b/sources/Interop/Windows/WinRT/winrt/windows.ui.composition.interop/ICompositionTextureInterop.xml index 54d0e47c4a..8415176061 100644 --- a/sources/Interop/Windows/WinRT/winrt/windows.ui.composition.interop/ICompositionTextureInterop.xml +++ b/sources/Interop/Windows/WinRT/winrt/windows.ui.composition.interop/ICompositionTextureInterop.xml @@ -6,6 +6,7 @@ Retrieves a Direct3D synchronization fence/value pair that indicates when the composition texture will become available, if that info is known. The value returned depends on the availability state of the composition texture. An availability state specifies whether, and when, it's safe to render to the composition texture. See the Remarks section of for the availability states, their descriptions, and how GetAvailableFence behaves for each state. + If a composition texture becomes available, then your app must be careful to issue rendering only to the exact subregion of the Direct3D texture that it refers to. The returned fence value. An interface identifier. diff --git a/sources/Interop/Windows/WinRT/winrt/windows.ui.composition.interop/ICompositorInterop2.xml b/sources/Interop/Windows/WinRT/winrt/windows.ui.composition.interop/ICompositorInterop2.xml index 03f9347df9..7c3a0dad4a 100644 --- a/sources/Interop/Windows/WinRT/winrt/windows.ui.composition.interop/ICompositorInterop2.xml +++ b/sources/Interop/Windows/WinRT/winrt/windows.ui.composition.interop/ICompositorInterop2.xml @@ -3,7 +3,10 @@ - Queries whether the Direct3D device that you're using to render supports composition textures (without having to first allocate a Direct3D texture on that device). Before you attempt to create composition textures for D3D textures backed by a given Direct3D device, you should call CheckCompositionTextureSupport, passing that backing device. + + Queries whether the Direct3D device that you're using to render supports composition textures (without having to first allocate a Direct3D texture on that device). Before you attempt to create composition textures for D3D textures backed by a given Direct3D device, you should call CheckCompositionTextureSupport, passing that backing device. + Generally speaking, a rendering device that reports support for monitored fences via is able to support composition textures. But in rare cases, the operating system (OS) itself can disable the composition textures feature; in which case CheckCompositionTextureSupport will also report unsupported. + The backing Direct3D device. Points to a value of true if renderingDevice supports composition textures; otherwise 'false`. If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. diff --git a/sources/Interop/Windows/WinRT/winrt/winstring/WinRT.xml b/sources/Interop/Windows/WinRT/winrt/winstring/WinRT.xml index 378eb83901..13f8d45ea5 100644 --- a/sources/Interop/Windows/WinRT/winrt/winstring/WinRT.xml +++ b/sources/Interop/Windows/WinRT/winrt/winstring/WinRT.xml @@ -207,7 +207,7 @@ - The [**HSTRING**](/windows/win32/winrt/hstring) was created successfully. + The HSTRING was created successfully. @@ -232,7 +232,7 @@ - Failed to allocate the new [**HSTRING**](/windows/win32/winrt/hstring). + Failed to allocate the new HSTRING. @@ -276,7 +276,7 @@ - The [**HSTRING**](/windows/win32/winrt/hstring) was created successfully. + The HSTRING was created successfully. @@ -300,7 +300,7 @@ - Failed to allocate the new [**HSTRING**](/windows/win32/winrt/hstring). + Failed to allocate the new HSTRING. @@ -382,7 +382,7 @@ - The [**HSTRING**](/windows/win32/winrt/hstring) was copied successfully. + The HSTRING was copied successfully. @@ -407,7 +407,7 @@ - Failed to allocate the new [**HSTRING**](/windows/win32/winrt/hstring). + Failed to allocate the new HSTRING. @@ -475,7 +475,7 @@ - targetHString is not a correctly formed [**HSTRING**](/windows/win32/winrt/hstring). + targetHString is not a correctly formed HSTRING. @@ -530,7 +530,7 @@ - targetHString is not a correctly formed [**HSTRING**](/windows/win32/winrt/hstring). + targetHString is not a correctly formed HSTRING. @@ -566,7 +566,7 @@ - The [**HSTRING**](/windows/win32/winrt/hstring) was created successfully. + The HSTRING was created successfully. @@ -591,7 +591,7 @@ - The requested [**HSTRING**](/windows/win32/winrt/hstring) allocation size is too large. + The requested HSTRING allocation size is too large. @@ -603,7 +603,7 @@ - Failed to allocate the [**HSTRING**](/windows/win32/winrt/hstring) buffer. + Failed to allocate the HSTRING. @@ -629,7 +629,7 @@ - The [**HSTRING**](/windows/win32/winrt/hstring) was created successfully. + The HSTRING was created successfully. @@ -655,7 +655,7 @@ - bufferHandle was not created by calling the function, or the caller has overwritten the terminating NUL character in bufferHandle. + bufferHandle was not created by calling the function, or the caller has overwritten the terminating NULL character in bufferHandle. diff --git a/sources/Interop/Windows/Windows/shared/mmreg/HEAACWAVEFORMAT.xml b/sources/Interop/Windows/Windows/shared/mmreg/HEAACWAVEFORMAT.xml index 2bb7b242ff..ad679f4112 100644 --- a/sources/Interop/Windows/Windows/shared/mmreg/HEAACWAVEFORMAT.xml +++ b/sources/Interop/Windows/Windows/shared/mmreg/HEAACWAVEFORMAT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Contains format data for an AAC or HE-AAC stream that includes AudioSpecificConfig() data. diff --git a/sources/Interop/Windows/Windows/shared/mmreg/HEAACWAVEINFO.xml b/sources/Interop/Windows/Windows/shared/mmreg/HEAACWAVEINFO.xml index 8f019f08d5..5a0043d42a 100644 --- a/sources/Interop/Windows/Windows/shared/mmreg/HEAACWAVEINFO.xml +++ b/sources/Interop/Windows/Windows/shared/mmreg/HEAACWAVEINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Contains format data for an Advanced Audio Coding (AAC) or High-Efficiency Advanced Audio Coding (HE-AAC) stream. diff --git a/sources/Interop/Windows/Windows/shared/mmreg/MPEG1WAVEFORMAT.xml b/sources/Interop/Windows/Windows/shared/mmreg/MPEG1WAVEFORMAT.xml index a38b14b217..6142938562 100644 --- a/sources/Interop/Windows/Windows/shared/mmreg/MPEG1WAVEFORMAT.xml +++ b/sources/Interop/Windows/Windows/shared/mmreg/MPEG1WAVEFORMAT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The MPEG1WAVEFORMAT structure describes the format of MPEG-1 audio data. diff --git a/sources/Interop/Windows/Windows/shared/mmreg/MPEGLAYER3WAVEFORMAT.xml b/sources/Interop/Windows/Windows/shared/mmreg/MPEGLAYER3WAVEFORMAT.xml index f5f4f9fa71..304944ceac 100644 --- a/sources/Interop/Windows/Windows/shared/mmreg/MPEGLAYER3WAVEFORMAT.xml +++ b/sources/Interop/Windows/Windows/shared/mmreg/MPEGLAYER3WAVEFORMAT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The MPEGLAYER3WAVEFORMAT structure describes an MPEG Audio Layer-3 (MP3) audio format. diff --git a/sources/Interop/Windows/Windows/shared/mmreg/WAVEFORMATEXTENSIBLE.xml b/sources/Interop/Windows/Windows/shared/mmreg/WAVEFORMATEXTENSIBLE.xml index 723b9d65a0..9665a63723 100644 --- a/sources/Interop/Windows/Windows/shared/mmreg/WAVEFORMATEXTENSIBLE.xml +++ b/sources/Interop/Windows/Windows/shared/mmreg/WAVEFORMATEXTENSIBLE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The WAVEFORMATEXTENSIBLE structure defines the format of waveform-audio data for formats having more than two channels or higher sample resolutions than allowed by WAVEFORMATEX. It can also be used to define any format that can be defined by WAVEFORMATEX. diff --git a/sources/Interop/Windows/Windows/shared/strsafe/Windows.xml b/sources/Interop/Windows/Windows/shared/strsafe/Windows.xml new file mode 100644 index 0000000000..1e08810af5 --- /dev/null +++ b/sources/Interop/Windows/Windows/shared/strsafe/Windows.xml @@ -0,0 +1,24629 @@ + + + + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size, in bytes, of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and will receive the resultant string. The string at pszSrc, up to cbMaxAppend bytes, is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus either the length of pszDest or cbMaxAppend (whichever is smaller) plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This source string must be null-terminated. + The maximum number of bytes to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size, in bytes, of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and will receive the resultant string. The string at pszSrc, up to cbMaxAppend bytes, is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus either the length of pszDest or cbMaxAppend (whichever is smaller) plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This source string must be null-terminated. + The maximum number of bytes to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size, in bytes, of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and will receive the resultant string. The string at pszSrc, up to cbMaxAppend bytes, is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus either the length of pszDest or cbMaxAppend (whichever is smaller) plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This source string must be null-terminated. + The maximum number of bytes to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + StringCbCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the bytes used for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of bytes to append to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), an invalid flag was passed, or there are discrepancies between the size of the pszDest, cbDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + StringCbCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the bytes used for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of bytes to append to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), an invalid flag was passed, or there are discrepancies between the size of the pszDest, cbDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + StringCbCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the bytes used for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of bytes to append to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), an invalid flag was passed, or there are discrepancies between the size of the pszDest, cbDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + StringCbCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the bytes used for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of bytes to append to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), an invalid flag was passed, or there are discrepancies between the size of the pszDest, cbDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + StringCbCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the bytes used for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of bytes to append to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), an invalid flag was passed, or there are discrepancies between the size of the pszDest, cbDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + StringCbCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the bytes used for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of bytes to append to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), an invalid flag was passed, or there are discrepancies between the size of the pszDest, cbDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size, in bytes, of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and will receive the resultant string. The string at pszSrc, up to cbMaxAppend bytes, is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus either the length of pszDest or cbMaxAppend (whichever is smaller) plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This source string must be null-terminated. + The maximum number of bytes to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size, in bytes, of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and will receive the resultant string. The string at pszSrc, up to cbMaxAppend bytes, is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus either the length of pszDest or cbMaxAppend (whichever is smaller) plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This source string must be null-terminated. + The maximum number of bytes to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of bytes from one string to another string. The size, in bytes, of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and will receive the resultant string. The string at pszSrc, up to cbMaxAppend bytes, is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus either the length of pszDest or cbMaxAppend (whichever is smaller) plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This source string must be null-terminated. + The maximum number of bytes to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the length of pszDest plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + A pointer to a buffer containing the source string. This source string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + A pointer to a buffer containing the source string. This source string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + A pointer to a buffer containing the source string. This source string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in bytes. This value must be large enough to hold the copied bytes (the size of pszSrc or the value of cbSrc, whichever is smaller) and also account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the data was copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in bytes. This value must be large enough to hold the copied bytes (the size of pszSrc or the value of cbSrc, whichever is smaller) and also account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the data was copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in bytes. This value must be large enough to hold the copied bytes (the size of pszSrc or the value of cbSrc, whichever is smaller) and also account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the data was copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in bytes. This value must be at least large enough to hold the copied bytes (the length of pszSrc or the value of cbSrc, whichever is smaller) as well as to account for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in bytes. This value must be at least large enough to hold the copied bytes (the length of pszSrc or the value of cbSrc, whichever is smaller) as well as to account for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in bytes. This value must be at least large enough to hold the copied bytes (the length of pszSrc or the value of cbSrc, whichever is smaller) as well as to account for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in bytes. This value must be at least large enough to hold the copied bytes (the length of pszSrc or the value of cbSrc, whichever is smaller) as well as to account for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in bytes. This value must be at least large enough to hold the copied bytes (the length of pszSrc or the value of cbSrc, whichever is smaller) as well as to account for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in bytes. This value must be at least large enough to hold the copied bytes (the length of pszSrc or the value of cbSrc, whichever is smaller) as well as to account for the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in bytes. This value must be large enough to hold the copied bytes (the size of pszSrc or the value of cbSrc, whichever is smaller) and also account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the data was copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in bytes. This value must be large enough to hold the copied bytes (the size of pszSrc or the value of cbSrc, whichever is smaller) and also account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the data was copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of bytes from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in bytes. This value must be large enough to hold the copied bytes (the size of pszSrc or the value of cbSrc, whichever is smaller) and also account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The source string. This string must be null-terminated. + The maximum number of bytes to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the data was copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + A pointer to a buffer containing the source string. This source string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + A pointer to a buffer containing the source string. This source string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in bytes. This value must consider the length of pszSrc plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + A pointer to a buffer containing the source string. This source string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either less than sizeof(TCHAR) or larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGets is a replacement for the following functions:gets, _getws, _gettsStringCbGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is sizeof(TCHAR) or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGets is a replacement for the following functions:gets, _getws, _gettsStringCbGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is sizeof(TCHAR) or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGets is a replacement for the following functions:gets, _getws, _gettsStringCbGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is sizeof(TCHAR) or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control.StringCbGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCbGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which is to receive the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control.StringCbGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCbGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which is to receive the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control.StringCbGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCbGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which is to receive the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control.StringCbGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCbGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which is to receive the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control.StringCbGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCbGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which is to receive the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control.StringCbGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCbGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which is to receive the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGets is a replacement for the following functions:gets, _getws, _gettsStringCbGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is sizeof(TCHAR) or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGets is a replacement for the following functions:gets, _getws, _gettsStringCbGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is sizeof(TCHAR) or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCbGets is a replacement for the following functions:gets, _getws, _gettsStringCbGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the input. + The size of the destination buffer, in bytes. This value must be greater than sizeof(TCHAR) for the function to succeed. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cbDest is sizeof(TCHAR) or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in bytes. + + StringCbLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of bytes allowed in psz, including those used for the terminating null character. This value cannot exceed STRSAFE_MAX_CCH * sizeof(TCHAR). + The number of bytes in psz, excluding those used for the terminating null character. This value is valid only if pcb is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cbMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cbMax is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or psz is longer than cbMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in bytes. + + StringCbLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of bytes allowed in psz, including those used for the terminating null character. This value cannot exceed STRSAFE_MAX_CCH * sizeof(TCHAR). + The number of bytes in psz, excluding those used for the terminating null character. This value is valid only if pcb is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cbMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cbMax is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or psz is longer than cbMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in bytes. + + StringCbLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of bytes allowed in psz, including those used for the terminating null character. This value cannot exceed STRSAFE_MAX_CCH * sizeof(TCHAR). + The number of bytes in psz, excluding those used for the terminating null character. This value is valid only if pcb is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cbMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cbMax is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or psz is longer than cbMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in bytes. + + StringCbLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of bytes allowed in psz, including those used for the terminating null character. This value cannot exceed STRSAFE_MAX_CCH * sizeof(TCHAR). + The number of bytes in psz, excluding those used for the terminating null character. This value is valid only if pcb is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cbMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cbMax is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or psz is longer than cbMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in bytes. + + StringCbLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of bytes allowed in psz, including those used for the terminating null character. This value cannot exceed STRSAFE_MAX_CCH * sizeof(TCHAR). + The number of bytes in psz, excluding those used for the terminating null character. This value is valid only if pcb is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cbMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cbMax is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or psz is longer than cbMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in bytes. + + StringCbLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of bytes allowed in psz, including those used for the terminating null character. This value cannot exceed STRSAFE_MAX_CCH * sizeof(TCHAR). + The number of bytes in psz, excluding those used for the terminating null character. This value is valid only if pcb is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cbMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cbMax is larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or psz is longer than cbMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control. + + StringCbVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There is sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR), or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCbVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in bytes. This value must be sufficiently large to accommodate the final formatted string plus the terminating null character. The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR). + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cbDest is either 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR). + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that StringCchCat does not write past the end of this buffer. + + StringCchCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must be greater than or equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that StringCchCat does not write past the end of this buffer. + + StringCchCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must be greater than or equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that StringCchCat does not write past the end of this buffer. + + StringCchCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must be greater than or equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatEx is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated to pszSrc, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc, up to cchMaxAppend characters, is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus either the length of pszDest or cchMaxAppend (whichever is smaller). To this sum add 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc, up to cchMaxAppend characters, is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus either the length of pszDest or cchMaxAppend (whichever is smaller). To this sum add 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc, up to cchMaxAppend characters, is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus either the length of pszDest or cchMaxAppend (whichever is smaller). To this sum add 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than STRSAFE_MAX_CCH, an invalid flag was passed, or there are discrepancies between the size of the pszDest, cchDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than STRSAFE_MAX_CCH, an invalid flag was passed, or there are discrepancies between the size of the pszDest, cchDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than STRSAFE_MAX_CCH, an invalid flag was passed, or there are discrepancies between the size of the pszDest, cchDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than STRSAFE_MAX_CCH, an invalid flag was passed, or there are discrepancies between the size of the pszDest, cchDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than STRSAFE_MAX_CCH, an invalid flag was passed, or there are discrepancies between the size of the pszDest, cchDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCatNEx is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus the length of pszDest plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is appended to the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any pre-existing or truncated string in the destination buffer is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + If the function fails, pszDest is untouched. Nothing is added to the original contents. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than STRSAFE_MAX_CCH, an invalid flag was passed, or there are discrepancies between the size of the pszDest, cchDest, and the amount of material to append in pszSrc. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc, up to cchMaxAppend characters, is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus either the length of pszDest or cchMaxAppend (whichever is smaller). To this sum add 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc, up to cchMaxAppend characters, is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus either the length of pszDest or cchMaxAppend (whichever is smaller). To this sum add 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates the specified number of characters from one string to another string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCatN is a replacement for the following functions: + + + + strncat + + + + + + + + + + The destination buffer, which contains the string that is to be concatenated with pszSrc, and will receive the entire resultant string. The string at pszSrc, up to cchMaxAppend characters, is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus either the length of pszDest or cchMaxAppend (whichever is smaller). To this sum add 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is concatenated to the end of pszDest. This string must be null-terminated. + The maximum number of characters to be appended to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that StringCchCat does not write past the end of this buffer. + + StringCchCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must be greater than or equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that StringCchCat does not write past the end of this buffer. + + StringCchCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must be greater than or equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Concatenates one string to another string. The size of the destination buffer is provided to the function to ensure that StringCchCat does not write past the end of this buffer. + + StringCchCat is a replacement for the following functions: + + + + strcat, wcscat, _tcsat + + + + + + + + + + + + + + + + + + + + The destination buffer, which contains the string to which pszSrc is to be concatenated, and that will receive the entire resultant string. The string at pszSrc is added to the end of the string at pszDest. + The size of the destination buffer, in characters. This value must be greater than or equal the length of pszSrc plus the length of pszDest plus 1 to account for both strings and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string that is to be concatenated to the end of pszDest. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the strings were fully concatenated without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The concatenation operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of the buffer. + + StringCchCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to this function for additional control. + + StringCchCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of the buffer. + + StringCchCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to this function for additional control. + + StringCchCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of the buffer. + + StringCchCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to this function for additional control. + + StringCchCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of the buffer. + + StringCchCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to this function for additional control. + + StringCchCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of the buffer. + + StringCchCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to this function for additional control. + + StringCchCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of the buffer. + + StringCchCopyEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to this function for additional control. + + StringCchCopyEx is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that StringCchCopyN does not write past the end of this buffer. + + StringCchCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in characters. This value must be large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the characters were copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that StringCchCopyN does not write past the end of this buffer. + + StringCchCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in characters. This value must be large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the characters were copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that StringCchCopyN does not write past the end of this buffer. + + StringCchCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in characters. This value must be large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the characters were copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in characters. This value must be at least large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH, pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in characters. This value must be at least large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH, pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in characters. This value must be at least large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH, pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in characters. This value must be at least large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH, pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in characters. This value must be at least large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH, pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopyNEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchCopyNEx is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied string. + The size of pszDest, in characters. This value must be at least large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + Either pszDest or pszSrc is greater than STRSAFE_MAX_CCH, pszDest is NULL when there is source data present to copy, or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that StringCchCopyN does not write past the end of this buffer. + + StringCchCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in characters. This value must be large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the characters were copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that StringCchCopyN does not write past the end of this buffer. + + StringCchCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in characters. This value must be large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the characters were copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies the specified number of characters from one string to another. The size of the destination buffer is provided to the function to ensure that StringCchCopyN does not write past the end of this buffer. + + StringCchCopyN is a replacement for the following functions: + + + + strncpy, wcsncpy, _tcsncpy + + + + + The destination buffer, which receives the copied characters. + The size of pszDest, in characters. This value must be large enough to hold the copied characters (the length of pszSrc or the value of cchSrc, whichever is smaller) plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be readable up to cchSrc characters or a null terminator, whichever comes first. + The maximum number of characters to be copied from pszSrc to pszDest. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, the characters were copied from pszSrc without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Copies one string to another. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchCopy is a replacement for the following functions: + + + + strcpy, wcscpy, _tcscpy + + + + + + + + + + + + + + + The destination buffer, which receives the copied string. + The size of the destination buffer, in characters. This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The source string. This string must be null-terminated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Source data was present, fully copied without truncation, and the resultant destination buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGets is a replacement for the following functions:gets, _getws, _gettsStringCchGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGets is a replacement for the following functions:gets, _getws, _gettsStringCchGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGets is a replacement for the following functions:gets, _getws, _gettsStringCchGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control.StringCchGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCchGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control.StringCchGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCchGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control.StringCchGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCchGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control.StringCchGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCchGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control.StringCchGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCchGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGetsEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control.StringCchGetsEx is a replacement for the following functions:gets, _getws, _gettsStringCchGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as . + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value or an invalid flag was passed. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGets is a replacement for the following functions:gets, _getws, _gettsStringCchGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGets is a replacement for the following functions:gets, _getws, _gettsStringCchGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. +
+ Note  This function can only be used inline.
+ StringCchGets is a replacement for the following functions:gets, _getws, _gettsStringCchGets is not a replacement for fgets, which does not replace newline characters with a terminating null character. + The destination buffer, which receives the copied characters. + The size of the destination buffer, in characters. This value must be at least 2 for the function to succeed. The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH. If cchDest is too small to hold the full line of text, the data is truncated. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated. + + + + + + + STRSAFE_E_END_OF_FILE + + + + + Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is larger than the maximum allowed value. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The value in cchDest is 1 or less. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in characters. + + StringCchLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of characters allowed in psz, including the terminating null character. This value cannot exceed STRSAFE_MAX_CCH. + The number of characters in psz, not including the terminating null character. This value is valid only if pcch is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cchMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cchMax is larger than STRSAFE_MAX_CCH, or psz is longer than cchMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in characters. + + StringCchLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of characters allowed in psz, including the terminating null character. This value cannot exceed STRSAFE_MAX_CCH. + The number of characters in psz, not including the terminating null character. This value is valid only if pcch is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cchMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cchMax is larger than STRSAFE_MAX_CCH, or psz is longer than cchMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in characters. + + StringCchLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of characters allowed in psz, including the terminating null character. This value cannot exceed STRSAFE_MAX_CCH. + The number of characters in psz, not including the terminating null character. This value is valid only if pcch is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cchMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cchMax is larger than STRSAFE_MAX_CCH, or psz is longer than cchMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in characters. + + StringCchLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of characters allowed in psz, including the terminating null character. This value cannot exceed STRSAFE_MAX_CCH. + The number of characters in psz, not including the terminating null character. This value is valid only if pcch is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cchMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cchMax is larger than STRSAFE_MAX_CCH, or psz is longer than cchMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in characters. + + StringCchLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of characters allowed in psz, including the terminating null character. This value cannot exceed STRSAFE_MAX_CCH. + The number of characters in psz, not including the terminating null character. This value is valid only if pcch is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cchMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cchMax is larger than STRSAFE_MAX_CCH, or psz is longer than cchMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Determines whether a string exceeds the specified length, in characters. + + StringCchLength is a replacement for the following functions: + + + + strlen, wcslen, _tcslen + + + + + The string whose length is to be checked. + The maximum number of characters allowed in psz, including the terminating null character. This value cannot exceed STRSAFE_MAX_CCH. + The number of characters in psz, not including the terminating null character. This value is valid only if pcch is not NULL and the function succeeds. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + The string at psz was not NULL, and the length of the string (including the terminating null character) is less than or equal to cchMax characters. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in psz is NULL, cchMax is larger than STRSAFE_MAX_CCH, or psz is longer than cchMax. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchPrintfEx is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf is a replacement for the following functions: + + + + sprintf, swprintf, _stprintf + + + + + + + + + + + + + + + _snprintf, _snwprintf, _sntprintf + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The Arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintfEx adds to the functionality of by returning a pointer to the end of the destination string as well as the number of characters left unused in that string. Flags may also be passed to the function for additional control. + + StringCchVPrintfEx is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf is a replacement for the following functions: + + + + vsprintf, vswprintf, _vstprintf + + + + + vsnprintf, _vsnwprintf, _vsntprintf + + + + + + + + + + + + + + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + +  Note that this function returns an HRESULT value, unlike the functions that it replaces. + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_lEx is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string. + The number of unused characters in pszDest, including the terminating null character. If pcchRemaining is NULL, the count is not kept or returned. + + One or more of the following values. + + + Value + Meaning + + + + + + + STRSAFE_FILL_BEHIND_NULL + + + + 0x00000200 + + + + If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character. + + + + + + + STRSAFE_IGNORE_NULLS + + + + 0x00000100 + + + + Treat NULL string pointers like empty strings (TEXT("")). + + + + + + + STRSAFE_FILL_ON_FAILURE + + + + 0x00000400 + + + + If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten. + + + + + + + STRSAFE_NULL_ON_FAILURE + + + + 0x00000800 + + + + If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + + + + STRSAFE_NO_TRUNCATION + + + + 0x00001000 + + + + As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten. + + + + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH, or the destination buffer is already full. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + + + Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer. + + StringCchVPrintf_l is similar to but includes a parameter for locale information. + + The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList. + The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH. + The format string. This string must be null-terminated. For more information, see Format Specification Syntax. + The locale object. For more information, see _create_locale. + The arguments to be inserted into the pszFormat string. + + This function can return one of the following values. It is strongly recommended that you use the and macros to test the return value of this function. + + + Return code + Description + + + + + + + S_OK + + + + + There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated. + + + + + + + STRSAFE_E_INVALID_PARAMETER + + + + + The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH. + + + + + + + STRSAFE_E_INSUFFICIENT_BUFFER + + + + + The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition. + + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/shared/udpmib/MIB_UDP6ROW_OWNER_MODULE.xml b/sources/Interop/Windows/Windows/shared/udpmib/MIB_UDP6ROW_OWNER_MODULE.xml index b1bcbb7fcc..0304298123 100644 --- a/sources/Interop/Windows/Windows/shared/udpmib/MIB_UDP6ROW_OWNER_MODULE.xml +++ b/sources/Interop/Windows/Windows/shared/udpmib/MIB_UDP6ROW_OWNER_MODULE.xml @@ -3,7 +3,7 @@ - The MIB_UDP6ROW_OWNER_MODULE structure contains an entry from the User Datagram Protocol (UDP) listener table for IPv6 on the local computer. This entry also also includes any available ownership data and the process ID (PID) that issued the call to the function for the UDP endpoint. + The MIB_UDP6ROW_OWNER_MODULE structure contains an entry from the User Datagram Protocol (UDP) listener table for IPv6 on the local computer. This entry also includes any available ownership data and the process ID (PID) that issued the call to the function for the UDP endpoint. diff --git a/sources/Interop/Windows/Windows/shared/udpmib/MIB_UDPROW_OWNER_MODULE.xml b/sources/Interop/Windows/Windows/shared/udpmib/MIB_UDPROW_OWNER_MODULE.xml index 3b59f8796a..98c452990f 100644 --- a/sources/Interop/Windows/Windows/shared/udpmib/MIB_UDPROW_OWNER_MODULE.xml +++ b/sources/Interop/Windows/Windows/shared/udpmib/MIB_UDPROW_OWNER_MODULE.xml @@ -3,7 +3,7 @@ - The MIB_UDPROW_OWNER_MODULE structure contains an entry from the IPv4 User Datagram Protocol (UDP) listener table on the local computer. This entry also also includes any available ownership data and the process ID (PID) that issued the call to the function for the UDP endpoint. + The MIB_UDPROW_OWNER_MODULE structure contains an entry from the IPv4 User Datagram Protocol (UDP) listener table on the local computer. This entry also includes any available ownership data and the process ID (PID) that issued the call to the function for the UDP endpoint. diff --git a/sources/Interop/Windows/Windows/shared/ws2ipdef/Windows.xml b/sources/Interop/Windows/Windows/shared/ws2ipdef/Windows.xml new file mode 100644 index 0000000000..f8f95e8062 --- /dev/null +++ b/sources/Interop/Windows/Windows/shared/ws2ipdef/Windows.xml @@ -0,0 +1,144 @@ + + + + + + + Determines whether two IPv6 addresses are equal. + Pointer to the first address. + Pointer to the second address. + + true if the two addresses arguments point to values that are equal; otherwise, false. + + + Determines whether the address argument is an IPv6 loopback address. + Pointer to the address to test. + + true if the address is an IPv6 loopback address; otherwise, false. + + + Determines whether the address argument is the unspecified IPv6 address (in6addr_any). + The address to test. + + true if the address is the unspecified IPv6 address (in6addr_any); otherwise, false. + + + + + Determines whether two IPv6 addresses are equal. + Pointer to the first address. + Pointer to the second address. + + true if the two addresses arguments point to values that are equal; otherwise, false. + + + Determines whether the address argument is an IPv6 anycast address. + Pointer to the address to test. + + true if the address is an IPv6 anycast address; otherwise, false. + + + Determines whether the address argument is an IPv6 EUI-64 format address. + Pointer to the address to test. + + true if the address is an IPv6 EUI-64 format address; otherwise, false. + + + Determines whether the address argument is an IPv6 global address. + Pointer to the address to test. + + true if the address is an IPv6 global address; otherwise, false. + + + Determines whether the address argument is an IPv6 link-local address. + Pointer to the address to test. + + + true if the address is an IPv6 link-local address; otherwise, false. + Returns true for local-use IPv6 unicast addresses. Returns false for the IPv6 loopback address. Doesn't return true for IPv6 multicast addresses of link-local scope. + + + + Determines whether the address argument is an IPv6 loopback address. + Pointer to the address to test. + + true if the address is an IPv6 loopback address; otherwise, false. + + + Determines whether the address argument is an IPv6 multicast global address. + Pointer to the address to test. + + true if the address is an IPv6 multicast global address; otherwise, false. + + + Determines whether the address argument is an IPv6 multicast link-local address. + Pointer to the address to test. + + true if the address is an IPv6 multicast link-local address; otherwise, false. + + + Determines whether the address argument is an IPv6 multicast node-local address. + Pointer to the address to test. + + true if the address is an IPv6 multicast node-local address; otherwise, false. + + + Determines whether the address argument is an IPv6 multicast organization-local address. + Pointer to the address to test. + + true if the address is an IPv6 multicast organization-local address; otherwise, false. + + + Determines whether the address argument is an IPv6 multicast site-local address. + Pointer to the address to test. + + true if the address is an IPv6 multicast site-local address; otherwise, false. + + + Determines whether the address argument is an IPv6 multicast address. + Pointer to the address to test. + + true if the address is an IPv6 multicast address; otherwise, false. + + + Determines whether the address argument is an IPv6 site-local address. + Pointer to the address to test. + + + true if the address is an IPv6 site-local address; otherwise, false. + Returns true for local-use IPv6 unicast addresses. + + + + Determines whether the address argument is one of the 128 IPv6 subnet-reserved anycast addresses. + Pointer to the address to test. + + true if the address is one of the 128 IPv6 subnet-reserved anycast addresses; otherwise, false. + + + Determines whether the address argument is the IPv6 subnet router anycast address. + Pointer to the address to test. + + true if the address is the IPv6 subnet router anycast address; otherwise, false. + + + Determines whether the address argument is the unspecified IPv6 address (in6addr_any). + The address to test. + + true if the address is the unspecified IPv6 address (in6addr_any); otherwise, false. + + + Determines whether the address argument is an IPv4-compatible IPv6 address. + The address to test. + + + Determines whether the address argument is an IPv4-mapped IPv6 address. + The address to test. + + + Determines whether the address argument is an IPv4-translated IPv6 address. + The address to test. + + + + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/shared/wtypes/STATFLAG.xml b/sources/Interop/Windows/Windows/shared/wtypes/STATFLAG.xml index 4d7e016f94..59d1eb423b 100644 --- a/sources/Interop/Windows/Windows/shared/wtypes/STATFLAG.xml +++ b/sources/Interop/Windows/Windows/shared/wtypes/STATFLAG.xml @@ -9,7 +9,7 @@ Requests that the statistics include the pwcsName member of the structure. - Requests that the statistics not include the pwcsName member of the structure. If the name is omitted, there is no need for the,, and methods methods to allocate and free memory for the string value of the name, therefore the method reduces time and resources used in an allocation and free operation. + Requests that the statistics not include the pwcsName member of the structure. If the name is omitted, there is no need for the,, and methods to allocate and free memory for the string value of the name, therefore the method reduces time and resources used in an allocation and free operation. Not implemented. diff --git a/sources/Interop/Windows/Windows/um/AppxPackaging/IAppxBundleFactory2.xml b/sources/Interop/Windows/Windows/um/AppxPackaging/IAppxBundleFactory2.xml index d6a7710070..d560f0ed1b 100644 --- a/sources/Interop/Windows/Windows/um/AppxPackaging/IAppxBundleFactory2.xml +++ b/sources/Interop/Windows/Windows/um/AppxPackaging/IAppxBundleFactory2.xml @@ -4,7 +4,7 @@ Creates a read-only bundle object that reads its contents from an object, with an optional parameter for specifying the expected digest for the bundle. - The input stream that delivers the content of the package for reading. The stream must support , , and . If these methods fail, their error codes may be passed to and returned by this method. + The input stream that delivers the content of the package for reading. The stream must support , , and . If these methods fail, their error codes may be passed to and returned by this method. An LPCWSTR containing the expected digest, a hashed representation of the bundle file. The created bundle reader. diff --git a/sources/Interop/Windows/Windows/um/AppxPackaging/IAppxFactory3.xml b/sources/Interop/Windows/Windows/um/AppxPackaging/IAppxFactory3.xml index 39b4d72afb..a6a8ae17b6 100644 --- a/sources/Interop/Windows/Windows/um/AppxPackaging/IAppxFactory3.xml +++ b/sources/Interop/Windows/Windows/um/AppxPackaging/IAppxFactory3.xml @@ -14,7 +14,7 @@ Creates a read-only manifest object model from contents provided by an , with an optional parameter for specifying the expected digest for the manifest. - The input stream that delivers the manifest XML for reading. The stream must support , , and . If these methods fail, their error codes may be passed to and returned by this method. + The input stream that delivers the manifest XML for reading. The stream must support , , and . If these methods fail, their error codes may be passed to and returned by this method. An LPCWSTR containing the expected digest, a hashed representation of the manifest file. The created manifest reader. diff --git a/sources/Interop/Windows/Windows/um/CommCtrl/Windows.xml b/sources/Interop/Windows/Windows/um/CommCtrl/Windows.xml index 5f1b20b0c8..2e659034ba 100644 --- a/sources/Interop/Windows/Windows/um/CommCtrl/Windows.xml +++ b/sources/Interop/Windows/Windows/um/CommCtrl/Windows.xml @@ -5795,7 +5795,7 @@ A pointer to a null-terminated, Unicode buffer that contains location information about the icon to load. If hinst is non-NULL, pszName specifies the icon resource either by name or ordinal. This ordinal must be packaged by using the macro. - If hinst is NULL, pszName specifies either the name of a standalone icon (.ico) file or the identifier (beginning with the IDI_ prefix) of a predefined system icon to load. + If hinst is NULL, pszName specifies the identifier (beginning with the IDI_ prefix) of a predefined system icon to load. The desired metric. One of the following values: @@ -5862,7 +5862,7 @@ A pointer to a null-terminated, Unicode buffer that contains location information about the icon to load. If hinst is non-NULL, pszName specifies the icon resource either by name or ordinal. This ordinal must be packaged by using the macro. - If hinst is NULL, pszName specifies either the name of a standalone icon (.ico) file or the identifier (beginning with the IDI_ prefix) of a predefined system icon to load. + If hinst is NULL, pszName specifies the identifier (beginning with the IDI_ prefix) of a predefined system icon to load. The desired width, in pixels, of the icon. The desired height, in pixels, of the icon. @@ -6784,6 +6784,13 @@ Yes button was selected. + + + IDCLOSE + + + Close button was selected. +  If this value is NULL, no value is returned. This function can return one of these values. diff --git a/sources/Interop/Windows/Windows/um/CommDlg/PRINTDLGA.xml b/sources/Interop/Windows/Windows/um/CommDlg/PRINTDLGA.xml index d17740a9d4..ecda2bb698 100644 --- a/sources/Interop/Windows/Windows/um/CommDlg/PRINTDLGA.xml +++ b/sources/Interop/Windows/Windows/um/CommDlg/PRINTDLGA.xml @@ -396,7 +396,7 @@ - This flag indicates whether your application supports multiple copies and collation. Set this flag on input to indicate that your application does not support multiple copies and collation. In this case, the nCopies member of the PRINTDLG structure always returns 1, and PD_COLLATE is never set in the Flags member. If this flag is not set, the application is responsible for printing and collating multiple copies. In this case, the nCopies member of the PRINTDLG structure indicates the number of copies the user wants to print, and the PD_COLLATE flag in the Flags member indicates whether the user wants collation.Regardless of whether this flag is set, an application can determine from nCopies and PD_COLLATE how many copies to render and whether to print them collated.If this flag is set and the printer driver does not support multiple copies, the Copies edit control is disabled. Similarly, if this flag is set and the printer driver does not support collation, the Collate check box is disabled.The dmCopies and dmCollate members of the structure contain the copies and collate information used by the printer driver. If this flag is set and the printer driver supports multiple copies, the dmCopies member indicates the number of copies requested by the user. If this flag is set and the printer driver supports collation, the dmCollate member of the DEVMODE structure indicates whether the user wants collation. If this flag is not set, the dmCopies member always returns 1, and the dmCollate member is always zero.Known issue on Windows 2000/XP/2003:  If this flag is not set before calling PrintDlg, PrintDlg might swap nCopies and dmCopies values when it returns. The workaround for this issue is use dmCopies if its value is larger than 1, else, use nCopies, for you to to get the actual number of copies to be printed when PrintDlg returns. + This flag indicates whether your application supports multiple copies and collation. Set this flag on input to indicate that your application does not support multiple copies and collation. In this case, the nCopies member of the PRINTDLG structure always returns 1, and PD_COLLATE is never set in the Flags member. If this flag is not set, the application is responsible for printing and collating multiple copies. In this case, the nCopies member of the PRINTDLG structure indicates the number of copies the user wants to print, and the PD_COLLATE flag in the Flags member indicates whether the user wants collation.Regardless of whether this flag is set, an application can determine from nCopies and PD_COLLATE how many copies to render and whether to print them collated.If this flag is set and the printer driver does not support multiple copies, the Copies edit control is disabled. Similarly, if this flag is set and the printer driver does not support collation, the Collate check box is disabled.The dmCopies and dmCollate members of the structure contain the copies and collate information used by the printer driver. If this flag is set and the printer driver supports multiple copies, the dmCopies member indicates the number of copies requested by the user. If this flag is set and the printer driver supports collation, the dmCollate member of the DEVMODE structure indicates whether the user wants collation. If this flag is not set, the dmCopies member always returns 1, and the dmCollate member is always zero.Known issue on Windows 2000/XP/2003:  If this flag is not set before calling PrintDlg, PrintDlg might swap nCopies and dmCopies values when it returns. The workaround for this issue is use dmCopies if its value is larger than 1, else, use nCopies, for you to get the actual number of copies to be printed when PrintDlg returns.  To ensure that PrintDlg or PrintDlgEx returns the correct values in the dmCopies and dmCollate members of the structure, set PD_RETURNDC = TRUE and PD_USEDEVMODECOPIESANDCOLLATE = TRUE. In so doing, the nCopies member of the PRINTDLG structure is always 1 and PD_COLLATE is always FALSE.To ensure that PrintDlg or PrintDlgEx returns the correct values in nCopies and PD_COLLATE, set PD_RETURNDC = TRUE and PD_USEDEVMODECOPIESANDCOLLATE = FALSE. In so doing, dmCopies is always 1 and dmCollate is always FALSE.On Windows Vista and Windows 7, when you call PrintDlg or PrintDlgEx with PD_RETURNDC set to TRUE and PD_USEDEVMODECOPIESANDCOLLATE set to FALSE, the PrintDlg or PrintDlgEx function sets the number of copies in the nCopies member of the PRINTDLG structure, and it sets the number of copies in the structure represented by the hDC member of the PRINTDLG structure.When making calls to GDI, you must ignore the value of nCopies, consider the value as 1, and use the returned hDC to avoid printing duplicate copies. @@ -837,7 +837,7 @@ - This flag indicates whether your application supports multiple copies and collation. Set this flag on input to indicate that your application does not support multiple copies and collation. In this case, the nCopies member of the PRINTDLG structure always returns 1, and PD_COLLATE is never set in the Flags member. If this flag is not set, the application is responsible for printing and collating multiple copies. In this case, the nCopies member of the PRINTDLG structure indicates the number of copies the user wants to print, and the PD_COLLATE flag in the Flags member indicates whether the user wants collation.Regardless of whether this flag is set, an application can determine from nCopies and PD_COLLATE how many copies to render and whether to print them collated.If this flag is set and the printer driver does not support multiple copies, the Copies edit control is disabled. Similarly, if this flag is set and the printer driver does not support collation, the Collate check box is disabled.The dmCopies and dmCollate members of the structure contain the copies and collate information used by the printer driver. If this flag is set and the printer driver supports multiple copies, the dmCopies member indicates the number of copies requested by the user. If this flag is set and the printer driver supports collation, the dmCollate member of the DEVMODE structure indicates whether the user wants collation. If this flag is not set, the dmCopies member always returns 1, and the dmCollate member is always zero.Known issue on Windows 2000/XP/2003:  If this flag is not set before calling PrintDlg, PrintDlg might swap nCopies and dmCopies values when it returns. The workaround for this issue is use dmCopies if its value is larger than 1, else, use nCopies, for you to to get the actual number of copies to be printed when PrintDlg returns. + This flag indicates whether your application supports multiple copies and collation. Set this flag on input to indicate that your application does not support multiple copies and collation. In this case, the nCopies member of the PRINTDLG structure always returns 1, and PD_COLLATE is never set in the Flags member. If this flag is not set, the application is responsible for printing and collating multiple copies. In this case, the nCopies member of the PRINTDLG structure indicates the number of copies the user wants to print, and the PD_COLLATE flag in the Flags member indicates whether the user wants collation.Regardless of whether this flag is set, an application can determine from nCopies and PD_COLLATE how many copies to render and whether to print them collated.If this flag is set and the printer driver does not support multiple copies, the Copies edit control is disabled. Similarly, if this flag is set and the printer driver does not support collation, the Collate check box is disabled.The dmCopies and dmCollate members of the structure contain the copies and collate information used by the printer driver. If this flag is set and the printer driver supports multiple copies, the dmCopies member indicates the number of copies requested by the user. If this flag is set and the printer driver supports collation, the dmCollate member of the DEVMODE structure indicates whether the user wants collation. If this flag is not set, the dmCopies member always returns 1, and the dmCollate member is always zero.Known issue on Windows 2000/XP/2003:  If this flag is not set before calling PrintDlg, PrintDlg might swap nCopies and dmCopies values when it returns. The workaround for this issue is use dmCopies if its value is larger than 1, else, use nCopies, for you to get the actual number of copies to be printed when PrintDlg returns.  To ensure that PrintDlg or PrintDlgEx returns the correct values in the dmCopies and dmCollate members of the structure, set PD_RETURNDC = TRUE and PD_USEDEVMODECOPIESANDCOLLATE = TRUE. In so doing, the nCopies member of the PRINTDLG structure is always 1 and PD_COLLATE is always FALSE.To ensure that PrintDlg or PrintDlgEx returns the correct values in nCopies and PD_COLLATE, set PD_RETURNDC = TRUE and PD_USEDEVMODECOPIESANDCOLLATE = FALSE. In so doing, dmCopies is always 1 and dmCollate is always FALSE.On Windows Vista and Windows 7, when you call PrintDlg or PrintDlgEx with PD_RETURNDC set to TRUE and PD_USEDEVMODECOPIESANDCOLLATE set to FALSE, the PrintDlg or PrintDlgEx function sets the number of copies in the nCopies member of the PRINTDLG structure, and it sets the number of copies in the structure represented by the hDC member of the PRINTDLG structure.When making calls to GDI, you must ignore the value of nCopies, consider the value as 1, and use the returned hDC to avoid printing duplicate copies. diff --git a/sources/Interop/Windows/Windows/um/CommDlg/PRINTDLGEXA.xml b/sources/Interop/Windows/Windows/um/CommDlg/PRINTDLGEXA.xml index 9916507152..db0ad7b4c7 100644 --- a/sources/Interop/Windows/Windows/um/CommDlg/PRINTDLGEXA.xml +++ b/sources/Interop/Windows/Windows/um/CommDlg/PRINTDLGEXA.xml @@ -26,7 +26,7 @@ - A handle to a device context or an information context, depending on whether the Flags member specifies the PD_RETURNDC or PC_RETURNIC flag. If neither flag is specified, the value of this member is undefined. If both flags are specified, PD_RETURNDC has priority. + A handle to a device context or an information context, depending on whether the Flags member specifies the PD_RETURNDC or PC_RETURNIC flag. If neither flag is specified, then the value of this member is undefined. If both flags are specified, then PD_RETURNDC has priority. If hDC isn't NULL, then you must call to free the GDI object after you no longer need it; otherwise you'll leak GDI objects whenever you call PrintDlgw APIs. diff --git a/sources/Interop/Windows/Windows/um/DispatcherQueue/DISPATCHERQUEUE_THREAD_APARTMENTTYPE.xml b/sources/Interop/Windows/Windows/um/DispatcherQueue/DISPATCHERQUEUE_THREAD_APARTMENTTYPE.xml index 4a4cd85486..481e257ef3 100644 --- a/sources/Interop/Windows/Windows/um/DispatcherQueue/DISPATCHERQUEUE_THREAD_APARTMENTTYPE.xml +++ b/sources/Interop/Windows/Windows/um/DispatcherQueue/DISPATCHERQUEUE_THREAD_APARTMENTTYPE.xml @@ -3,7 +3,7 @@ - Specifies the threading apartment type for a new DispatcherQueueController. + Defines constants that specify options around type of COM apartment for a new DispatcherQueueController. No COM threading apartment type specified. diff --git a/sources/Interop/Windows/Windows/um/DispatcherQueue/DISPATCHERQUEUE_THREAD_TYPE.xml b/sources/Interop/Windows/Windows/um/DispatcherQueue/DISPATCHERQUEUE_THREAD_TYPE.xml index 5c4b3fbb91..4b4fc356be 100644 --- a/sources/Interop/Windows/Windows/um/DispatcherQueue/DISPATCHERQUEUE_THREAD_TYPE.xml +++ b/sources/Interop/Windows/Windows/um/DispatcherQueue/DISPATCHERQUEUE_THREAD_TYPE.xml @@ -3,12 +3,12 @@ - Specifies the thread affinity for a new DispatcherQueueController. + Defines constants that specify options around threading affinity for a new DispatcherQueueController. - Specifies that the DispatcherQueueController be created on a dedicated thread. With this option, creates a thread, the DispatcherQueueController instance, and runs the dispatcher queue event loop on the newly created thread. + Specifies that the DispatcherQueue for the DispatcherQueueController will be created on a dedicated thread. - Specifies that the DispatcherQueueController will be created on the caller's thread. + Specifies that the DispatcherQueue for the DispatcherQueueController will be created on the caller's thread. \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/DispatcherQueue/DispatcherQueueOptions.xml b/sources/Interop/Windows/Windows/um/DispatcherQueue/DispatcherQueueOptions.xml index c1d38de536..d910ff3982 100644 --- a/sources/Interop/Windows/Windows/um/DispatcherQueue/DispatcherQueueOptions.xml +++ b/sources/Interop/Windows/Windows/um/DispatcherQueue/DispatcherQueueOptions.xml @@ -3,15 +3,15 @@ - Specifies the threading and apartment type for a new DispatcherQueueController. + Represents options around threading affinity and type of COM apartment for a new DispatcherQueueController. Size of this DispatcherQueueOptions structure. - Thread affinity for the created DispatcherQueueController. + Thread affinity for a new DispatcherQueueController. - Specifies whether to initialize COM apartment on the new thread as an application single-threaded apartment (ASTA) or single-threaded apartment (STA). This field is only relevant if threadType is DQTYPE_THREAD_DEDICATED. Use DQTAT_COM_NONE when DispatcherQueueOptions.threadType is DQTYPE_THREAD_CURRENT. + Specifies whether to initialize the COM apartment on the new thread as an application single-threaded apartment (ASTA) or a single-threaded apartment (STA). This field is relevant only if threadType is DQTYPE_THREAD_DEDICATED. Use DQTAT_COM_NONE when DispatcherQueueOptions.threadType is DQTYPE_THREAD_CURRENT. \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/DispatcherQueue/Windows.xml b/sources/Interop/Windows/Windows/um/DispatcherQueue/Windows.xml index 650b20b537..878924a355 100644 --- a/sources/Interop/Windows/Windows/um/DispatcherQueue/Windows.xml +++ b/sources/Interop/Windows/Windows/um/DispatcherQueue/Windows.xml @@ -3,7 +3,7 @@ - Creates a DispatcherQueueController on the caller's thread. Use the created DispatcherQueueController to create and manage the lifetime of a DispatcherQueue to run queued tasks in priority order on the Dispatcher queue's thread. + Creates a DispatcherQueueController. Use the created DispatcherQueueController to create and manage the lifetime of a DispatcherQueue to run queued tasks in priority order on the dispatcher queue's thread. The threading affinity and type of COM apartment for the created DispatcherQueueController. See remarks for details. The created dispatcher queue controller. diff --git a/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedAppLauncher.xml b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedAppLauncher.xml index cb769e788a..db6475cc40 100644 --- a/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedAppLauncher.xml +++ b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedAppLauncher.xml @@ -2,7 +2,14 @@ + + Launches an app inside the container. + The application user model ID (AUMID) of the app to launch. + The arguments to pass to the app. + The telemetry parameters to pass to the app. + Returns an HRESULT success or error code. + - Enables apps to determine whether they are running in a Windows Defender Application Guard container (VM container environment). + Enables apps to determine whether they are running in a Microsoft Defender Application Guard container (VM container environment). \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedProcessLauncher.xml b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedProcessLauncher.xml new file mode 100644 index 0000000000..4e94886d39 --- /dev/null +++ b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedProcessLauncher.xml @@ -0,0 +1,36 @@ + + + + + + Allows the remote window to reflecting what is going on in the container. + The process ID. + Returns an HRESULT success or error code. + + + Returns the container/VM Id. + The container/VM Id. + Returns an HRESULT success or error code. + + + Determines if a container is running or suspended. + The running parameter is set to true if the container is running, or false if the container is suspended. + Returns an HRESULT success or error code. + + + Launches a process inside the container. + The process to launch. + The arguments to pass to the process. + The working directory of the process. + Returns an HRESULT success or error code. + + + Shares a host directory into the container, either as read-only or supporting modification. + The path to the directory on the host to share. + The path to the directory in the container to map to the host path. + Determines if the directory is shared as read-only or read-write. + + + Enables apps to determine whether processes are running in a Microsoft Defender Application Guard (MDAG) container (VM container environment). + + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedProcessLauncher2.xml b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedProcessLauncher2.xml new file mode 100644 index 0000000000..2001ebe240 --- /dev/null +++ b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IIsolatedProcessLauncher2.xml @@ -0,0 +1,15 @@ + + + + + + Launches a process in an isolated environment. + The process to launch. + The working directory of the process. + The correlation GUID to associate with the process. + Returns an HRESULT success or error code. + + + Enables apps to determine whether processes are running in a Microsoft Defender Application Guard (MDAG) container (VM container environment). + + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IsolatedAppLauncherTelemetryParameters.xml b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IsolatedAppLauncherTelemetryParameters.xml new file mode 100644 index 0000000000..ce5610c26b --- /dev/null +++ b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/IsolatedAppLauncherTelemetryParameters.xml @@ -0,0 +1,14 @@ + + + + + + A struct that provides telemetry parameters to be used when launching an app inside the container. + + + The EnableForLaunch field is a boolean value that indicates whether telemetry is enabled for the launch. + + + The CorrelationGUID field is a GUID that is used to correlate telemetry events. + + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/Windows.xml b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/Windows.xml new file mode 100644 index 0000000000..3bf9d4f114 --- /dev/null +++ b/sources/Interop/Windows/Windows/um/IsolatedAppLauncher/Windows.xml @@ -0,0 +1,16 @@ + + + + + + Determines if a process is running in an isolated container. + Indicates whether the process is running in an isolated container. + Returns an HRESULT success or error code. + + + Determines if a process is running in a Microsoft Defender Application Guard (MDAG) container. + This parameter is reserved for future use. + This indicates whether the process is running in a MDAG container. + Returns an HRESULT success or error code. + + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/MDMRegistration/Windows.xml b/sources/Interop/Windows/Windows/um/MDMRegistration/Windows.xml index 4b0001fb13..c025d46d7f 100644 --- a/sources/Interop/Windows/Windows/um/MDMRegistration/Windows.xml +++ b/sources/Interop/Windows/Windows/um/MDMRegistration/Windows.xml @@ -75,7 +75,7 @@ Sets the config info associated with the provider ID. A string containing the provider ID. - A string containing containing the config info (the data to write). + A string containing the config info (the data to write). If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULTerror code. diff --git a/sources/Interop/Windows/Windows/um/Msi/Windows.xml b/sources/Interop/Windows/Windows/um/Msi/Windows.xml index 79dd458f40..3a379d40d9 100644 --- a/sources/Interop/Windows/Windows/um/Msi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/Msi/Windows.xml @@ -10092,7 +10092,7 @@ - Logging information is collected but is is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. + Logging information is collected but is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. @@ -10338,7 +10338,7 @@ - Logging information is collected but is is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. + Logging information is collected but is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. @@ -10584,7 +10584,7 @@ - Logging information is collected but is is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. + Logging information is collected but is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. @@ -10830,7 +10830,7 @@ - Logging information is collected but is is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. + Logging information is collected but is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. @@ -11076,7 +11076,7 @@ - Logging information is collected but is is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. + Logging information is collected but is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. @@ -11322,7 +11322,7 @@ - Logging information is collected but is is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. + Logging information is collected but is less frequently saved to the log file. This can improve the performance of some installations, but may have little benefit for large installations. The log file is removed when the installation succeeds. If the installation fails, all logging information is saved to the log file. Windows Installer 2.0:  This log mode is not available. diff --git a/sources/Interop/Windows/Windows/um/ShObjIdl_core/IAppVisibility.xml b/sources/Interop/Windows/Windows/um/ShObjIdl_core/IAppVisibility.xml index 203234dea2..727d60d343 100644 --- a/sources/Interop/Windows/Windows/um/ShObjIdl_core/IAppVisibility.xml +++ b/sources/Interop/Windows/Windows/um/ShObjIdl_core/IAppVisibility.xml @@ -85,7 +85,7 @@ Cancels a connection that was previously established by using . - A token that uniquely identifies the connection to cancel, which is provided by a previous call to to the method. + A token that uniquely identifies the connection to cancel, which is provided by a previous call to the method. If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. diff --git a/sources/Interop/Windows/Windows/um/ShObjIdl_core/ICommDlgBrowser2.xml b/sources/Interop/Windows/Windows/um/ShObjIdl_core/ICommDlgBrowser2.xml index e4ca7b4256..c10666c2b5 100644 --- a/sources/Interop/Windows/Windows/um/ShObjIdl_core/ICommDlgBrowser2.xml +++ b/sources/Interop/Windows/Windows/um/ShObjIdl_core/ICommDlgBrowser2.xml @@ -34,7 +34,7 @@ Called by a Shell view to notify the common dialog box hosting it that an event has occurred. A pointer to the interface of the hosted view. - A flag that can can take one of the following two values. + A flag that can take one of the following two values.

CDB2N_CONTEXTMENU_START

Indicates that the shortcut menu is about to be displayed.

CDB2N_CONTEXTMENU_DONE

diff --git a/sources/Interop/Windows/Windows/um/ShObjIdl_core/IShellIconOverlayIdentifier.xml b/sources/Interop/Windows/Windows/um/ShObjIdl_core/IShellIconOverlayIdentifier.xml index 3395916a54..412fa06b2d 100644 --- a/sources/Interop/Windows/Windows/um/ShObjIdl_core/IShellIconOverlayIdentifier.xml +++ b/sources/Interop/Windows/Windows/um/ShObjIdl_core/IShellIconOverlayIdentifier.xml @@ -24,7 +24,7 @@ Specifies whether an icon overlay should be added to a Shell object's icon. A Unicode string that contains the fully qualified path of the Shell object. - The object's attributes. For a complete list of file attributes and their associated flags, see . + The object's attributes. For a complete list of file attributes and their associated flags, see File Attribute Constants. This method returns one of the following: diff --git a/sources/Interop/Windows/Windows/um/ShObjIdl_core/SHCONTF.xml b/sources/Interop/Windows/Windows/um/ShObjIdl_core/SHCONTF.xml index 7564f68335..aeca4ef1ba 100644 --- a/sources/Interop/Windows/Windows/um/ShObjIdl_core/SHCONTF.xml +++ b/sources/Interop/Windows/Windows/um/ShObjIdl_core/SHCONTF.xml @@ -36,7 +36,7 @@ 0x02000. Windows Vista and later. The calling application is looking for resources that can be enumerated quickly. - 0x04000. Windows Vista and later. Enumerate items as a simple list even if the folder itself is not structured in that way. + 0x04000. Windows Vista and later. Obsolete. Do not use. 0x08000. Windows Vista and later. The calling application is monitoring for change notifications. This means that the enumerator does not have to return all results. Items can be reported through change notifications. diff --git a/sources/Interop/Windows/Windows/um/Shlwapi/PARSEDURLA.xml b/sources/Interop/Windows/Windows/um/Shlwapi/PARSEDURLA.xml index 3f8bd8a8a4..33c705cb27 100644 --- a/sources/Interop/Windows/Windows/um/Shlwapi/PARSEDURLA.xml +++ b/sources/Interop/Windows/Windows/um/Shlwapi/PARSEDURLA.xml @@ -12,7 +12,7 @@ [out] A pointer to the beginning of the protocol part of the URL. - The number of characters in the URL's protocol section. + [out] The number of characters in the URL's protocol section. [out] A pointer to the section of the URL that follows the protocol and colon (':'). For file URLs, the function also skips the leading "//" characters. @@ -33,7 +33,7 @@ [out] A pointer to the beginning of the protocol part of the URL. - The number of characters in the URL's protocol section. + [out] The number of characters in the URL's protocol section. [out] A pointer to the section of the URL that follows the protocol and colon (':'). For file URLs, the function also skips the leading "//" characters. diff --git a/sources/Interop/Windows/Windows/um/Shlwapi/Windows.xml b/sources/Interop/Windows/Windows/um/Shlwapi/Windows.xml index f2ae37c62b..e92a173227 100644 --- a/sources/Interop/Windows/Windows/um/Shlwapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/Shlwapi/Windows.xml @@ -188,14 +188,24 @@ The value that specifies the type of string that is to be returned. A pointer to a null-terminated string that is used to determine the root key. The following four types of strings can be used. -

File name extension

- A file name extension, such as .txt. -

CLSID

- A CLSID GUID in the standard "{GUID}" format. -

ProgID

- An application's ProgID, such as Word.Document.8. -

Executable name

- The name of an application's .exe file. The flag must be set in flags. + + + + File name extension: A file name extension, such as .txt. + + + + CLSID: A CLSID GUID in the standard "{GUID}" format. + + + + ProgID: An application's ProgID, such as Word.Document.8. + + + + Executable name: The name of an application's .exe file. The flag must be set in flags. + + An optional null-terminated string with additional information about the location of the string. It is typically set to a Shell verb such as open. Set this parameter to NULL if it is not used. Pointer to a null-terminated string that, when this function returns successfully, receives the requested string. Set this parameter to NULL to retrieve the required buffer size. @@ -233,14 +243,24 @@ The value that specifies the type of string that is to be returned. A pointer to a null-terminated string that is used to determine the root key. The following four types of strings can be used. -

File name extension

- A file name extension, such as .txt. -

CLSID

- A CLSID GUID in the standard "{GUID}" format. -

ProgID

- An application's ProgID, such as Word.Document.8. -

Executable name

- The name of an application's .exe file. The flag must be set in flags. + + + + File name extension: A file name extension, such as .txt. + + + + CLSID: A CLSID GUID in the standard "{GUID}" format. + + + + ProgID: An application's ProgID, such as Word.Document.8. + + + + Executable name: The name of an application's .exe file. The flag must be set in flags. + + An optional null-terminated string with additional information about the location of the string. It is typically set to a Shell verb such as open. Set this parameter to NULL if it is not used. Pointer to a null-terminated string that, when this function returns successfully, receives the requested string. Set this parameter to NULL to retrieve the required buffer size. @@ -278,14 +298,24 @@ The value that specifies the type of string that is to be returned. A pointer to a null-terminated string that is used to determine the root key. The following four types of strings can be used. -

File name extension

- A file name extension, such as .txt. -

CLSID

- A CLSID GUID in the standard "{GUID}" format. -

ProgID

- An application's ProgID, such as Word.Document.8. -

Executable name

- The name of an application's .exe file. The flag must be set in flags. + + + + File name extension: A file name extension, such as .txt. + + + + CLSID: A CLSID GUID in the standard "{GUID}" format. + + + + ProgID: An application's ProgID, such as Word.Document.8. + + + + Executable name: The name of an application's .exe file. The flag must be set in flags. + + An optional null-terminated string with additional information about the location of the string. It is typically set to a Shell verb such as open. Set this parameter to NULL if it is not used. Pointer to a null-terminated string that, when this function returns successfully, receives the requested string. Set this parameter to NULL to retrieve the required buffer size. diff --git a/sources/Interop/Windows/Windows/um/UserEnv/Windows.xml b/sources/Interop/Windows/Windows/um/UserEnv/Windows.xml index 8f222b641b..241667a13e 100644 --- a/sources/Interop/Windows/Windows/um/UserEnv/Windows.xml +++ b/sources/Interop/Windows/Windows/um/UserEnv/Windows.xml @@ -3,15 +3,15 @@ - Creates a per-user, per-app profile for Windows Store apps. - The name of the app container. To ensure uniqueness, it is recommended that this string contains the app name as well as the publisher. This string can be up to 64 characters in length. Further, it must fit into the pattern described by the regular expression "[-_. A-Za-z0-9]+". + Creates a per-user, per-app profile for an AppContainer. + The name of the app container. To ensure uniqueness, this string should ideally contain the app name as well as the publisher. This string can be up to 64 characters in length. Further, it must fit into the pattern described by the regular expression "[-_. A-Za-z0-9]+". The display name. This string can be up to 512 characters in length. A description for the app container. This string can be up to 2048 characters in length. - The SIDs that define the requested capabilities. + The SIDs that define the requested UWP capabilities (if applicable). The number of SIDs in pCapabilities. - The SID for the profile. This buffer must be freed using the function. + The SID for the profile. This buffer must be freed using the function. - If this function succeeds, it returns a standard HRESULT code, including the following: + If this function succeeds, then it returns a standard HRESULT code, including the following: Return code @@ -39,7 +39,7 @@ - The caller does not have permission to create the profile. + The caller doesn't have permission to create the profile. diff --git a/sources/Interop/Windows/Windows/um/WebServices/WS_SECURE_CONVERSATION_VERSION.xml b/sources/Interop/Windows/Windows/um/WebServices/WS_SECURE_CONVERSATION_VERSION.xml index 0dcc2e981b..1884d6340a 100644 --- a/sources/Interop/Windows/Windows/um/WebServices/WS_SECURE_CONVERSATION_VERSION.xml +++ b/sources/Interop/Windows/Windows/um/WebServices/WS_SECURE_CONVERSATION_VERSION.xml @@ -6,9 +6,9 @@ Defines the WS-SecureConversation specification version to be used with message security and mixed-mode security. - WS-SecureConversation with the specification URI of http://schemas.xmlsoap.org/ws/2005/02/sc + WS-SecureConversation with the specification URI of http://schemas.xmlsoap.org/ws/2005/02/sc. - WS-SecureConversation 1.3 with the specification URI of http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512 + WS-SecureConversation 1.3 with the specification URI of http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512. \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/WebServices/WS_SECURITY_TOKEN_PROPERTY_ID.xml b/sources/Interop/Windows/Windows/um/WebServices/WS_SECURITY_TOKEN_PROPERTY_ID.xml index cd3035f465..761f7ee805 100644 --- a/sources/Interop/Windows/Windows/um/WebServices/WS_SECURITY_TOKEN_PROPERTY_ID.xml +++ b/sources/Interop/Windows/Windows/um/WebServices/WS_SECURITY_TOKEN_PROPERTY_ID.xml @@ -29,7 +29,7 @@ The accompanying value parameter of the function is a pointer to a structure containing the raw key data of the symmetric token key. This property is available when is. - If the token was obtained via , the returned buffer contains key material generated during the token request, which is either entropy generated by the client, entropy generated by the server or key material derived from from both client and server entropy, depending on . + If the token was obtained via , the returned buffer contains key material generated during the token request, which is either entropy generated by the client, entropy generated by the server or key material derived from both client and server entropy, depending on . When using this property with , the 'heap' parameter must be non-NULL. The returned buffer should be securely erased or encrypted immediately after use to prevent leaking of sensitive data. diff --git a/sources/Interop/Windows/Windows/um/WebServices/WS_TRUST_VERSION.xml b/sources/Interop/Windows/Windows/um/WebServices/WS_TRUST_VERSION.xml index 8579711adb..ba40a5b6d4 100644 --- a/sources/Interop/Windows/Windows/um/WebServices/WS_TRUST_VERSION.xml +++ b/sources/Interop/Windows/Windows/um/WebServices/WS_TRUST_VERSION.xml @@ -6,9 +6,9 @@ Defines the WS-Trust specification version to be used with message security and mixed-mode security. - WS-Trust with the specification URI of http://schemas.xmlsoap.org/ws/2005/02/trust + WS-Trust with the specification URI of http://schemas.xmlsoap.org/ws/2005/02/trust. - WS-Trust 1.3 with the specification URI of http://docs.oasis-open.org/ws-sx/ws-trust/200512 + WS-Trust 1.3 with the specification URI of http://docs.oasis-open.org/ws-sx/ws-trust/200512. \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/WebServices/WS_TYPE_MAPPING.xml b/sources/Interop/Windows/Windows/um/WebServices/WS_TYPE_MAPPING.xml index 3531057b0b..65b51070ad 100644 --- a/sources/Interop/Windows/Windows/um/WebServices/WS_TYPE_MAPPING.xml +++ b/sources/Interop/Windows/Windows/um/WebServices/WS_TYPE_MAPPING.xml @@ -25,7 +25,7 @@ - This is used when when the type corresponds to all or part of the content (text and child elements) of an element. The definition of the type may include mappings to text or child elements, but must not include any attributes. + This is used when the type corresponds to all or part of the content (text and child elements) of an element. The definition of the type may include mappings to text or child elements, but must not include any attributes. The following calling sequence is used when writing the contents of an element: WsWriteStartElement(...) // Write attributes, if any // Write other element content, if any WsWriteType(..., WS_ELEMENT_CONTENT_TYPE_MAPPING, ...) // Write other element content, if any WsWriteEndElement(...) The following calling sequence is used when reading the contents of an element: @@ -34,7 +34,7 @@ - This is used when when the type corresponds to the complete element, including the name and namespace of the element. The definition may include attributes and child elements and text. + This is used when the type corresponds to the complete element, including the name and namespace of the element. The definition may include attributes and child elements and text. The following calling sequence is used when writing an element: WsWriteType(..., WS_ANY_ELEMENT_TYPE_MAPPING, ...) The following calling sequence is used when reading the contents of an element: diff --git a/sources/Interop/Windows/Windows/um/WebServices/Windows.xml b/sources/Interop/Windows/Windows/um/WebServices/Windows.xml index 13f17678c4..3422c43244 100644 --- a/sources/Interop/Windows/Windows/um/WebServices/Windows.xml +++ b/sources/Interop/Windows/Windows/um/WebServices/Windows.xml @@ -368,7 +368,7 @@ Adds a specified mapped header to the message. - Pointer to a WS_MESSAGE structure representing the message to to which to add the mapped header. + Pointer to a WS_MESSAGE structure representing the message to which to add the mapped header. The message can be in any state except WS_MESSAGE_STATE_EMPTY (see the enumeration. Pointer to a containing the name of the header. @@ -9605,7 +9605,7 @@ A pointer to the Channel on which to set the property and may not be NULL. Identifier of the property to set. A void pointer to the property value to set. The pointer must have an alignment compatible with the type of the property. - The size in bytes of of the property value. + The size in bytes of the property value. A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails. This function can return one of these values. @@ -11923,7 +11923,7 @@ - This operation starts writing an attribute to the current element. must be called before an attribute can be written. After the attribute has been started, the attribute value can be written using , , or . The attribute must be completed using using . + This operation starts writing an attribute to the current element. must be called before an attribute can be written. After the attribute has been started, the attribute value can be written using , , or . The attribute must be completed using . A pointer to the WS_XML_WRITER object to which the attribute is written. The pointer must reference a valid XML Writer object. A WS_XML_STRING pointer to the prefix to use for the attribute. If the value referenced by this parameter is NULL the Writer will choose a attribute. A WS_XML_STRING pointer to the local name used by the attribute. It must be at least one character long. diff --git a/sources/Interop/Windows/Windows/um/WinBase/COPYFILE2_EXTENDED_PARAMETERS.xml b/sources/Interop/Windows/Windows/um/WinBase/COPYFILE2_EXTENDED_PARAMETERS.xml index c0415059e8..34cc8f3055 100644 --- a/sources/Interop/Windows/Windows/um/WinBase/COPYFILE2_EXTENDED_PARAMETERS.xml +++ b/sources/Interop/Windows/Windows/um/WinBase/COPYFILE2_EXTENDED_PARAMETERS.xml @@ -3,182 +3,24 @@ - Contains extended parameters for the function. + Contains extended parameters for the function. - Contains the size of this structure,sizeof(COPYFILE2_EXTENDED_PARAMETERS). + Contains the size of this structure, sizeof(COPYFILE2_EXTENDED_PARAMETERS). Contains a combination of zero or more of these flag values. - - - Value - Meaning - - - - - - - COPY_FILE_ALLOW_DECRYPTED_DESTINATION - - - - 0x00000008 - - - - The copy will be attempted even if the destination file cannot be encrypted. - - - - - - - COPY_FILE_COPY_SYMLINK - - - - 0x00000800 - - - - If the source file is a symbolic link, the destination file is also a symbolic link pointing to the same file as the source symbolic link. - - - - - - - COPY_FILE_FAIL_IF_EXISTS - - - - 0x00000001 - - - - If the destination file exists the copy operation fails immediately. If a file or directory exists with the destination name then the function call will fail with either HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS) or HRESULT_FROM_WIN32(ERROR_FILE_EXISTS). If COPY_FILE_RESUME_FROM_PAUSE is also specified then a failure is only triggered if the destination file does not have a valid restart header. - - - - - - - COPY_FILE_NO_BUFFERING - - - - 0x00001000 - - - - The copy is performed using unbuffered I/O, bypassing the system cache resources. This flag is recommended for very large file copies. It is not recommended to pause copies that are using this flag. - - - - - - - COPY_FILE_NO_OFFLOAD - - - - 0x00040000 - - - - Do not attempt to use the Windows Copy Offload mechanism. This is not generally recommended. - - - - - - - COPY_FILE_OPEN_SOURCE_FOR_WRITE - - - - 0x00000004 - - - - The file is copied and the source file is opened for write access. - - - - - - - COPY_FILE_RESTARTABLE - - - - 0x00000002 - - - - The file is copied in a manner that can be restarted if the same source and destination filenames are used again. This is slower. - - - - - - - COPY_FILE_REQUEST_SECURITY_PRIVILEGES - - - - 0x00002000 - - - - The copy is attempted, specifying ACCESS_SYSTEM_SECURITY for the source file and ACCESS_SYSTEM_SECURITY | WRITE_DAC | WRITE_OWNER for the destination file. If these requests are denied the access request will be reduced to the highest privilege level for which access is granted. For more information see SACL Access Right. This can be used to allow the CopyFile2ProgressRoutine callback to perform operations requiring higher privileges, such as copying the security attributes for the file. - - - - - - - COPY_FILE_RESUME_FROM_PAUSE - - - - 0x00004000 - - - - The destination file is examined to see if it was copied using COPY_FILE_RESTARTABLE. If so the copy is resumed. If not the file will be fully copied. - - - - - - - COPY_FILE_REQUEST_COMPRESSED_TRAFFIC - - - - 0x10000000 - - - - - Request the underlying transfer channel compress the data during the copy operation. The request may not be supported for all mediums, in which case it is ignored. The compression attributes and parameters (computational complexity, memory usage) are not configurable through this API, and are subject to change between different OS releases. - This flag was introduced in Windows 10, version 1903 and Windows Server 2022. On Windows 10, the flag is supported for files residing on SMB shares, where the negotiated SMB protocol version is SMB v3.1.1 or greater. - - - + | Value | Meaning | | ----- | ------- | | COPY_FILE_FAIL_IF_EXISTS
0x00000001 | If the destination file exists the copy operation fails immediately. If a file or directory exists with the destination name then the function call will fail with either HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS) or HRESULT_FROM_WIN32(ERROR_FILE_EXISTS). If COPY_FILE_RESUME_FROM_PAUSE is also specified then a failure is only triggered if the destination file does not have a valid restart header. | | COPY_FILE_RESTARTABLE
0x00000002 | The file is copied in a manner that can be restarted if the same source and destination filenames are used again. This is slower. | | COPY_FILE_OPEN_SOURCE_FOR_WRITE
0x00000004 | The file is copied and the source file is opened for write access. | | COPY_FILE_ALLOW_DECRYPTED_DESTINATION
0x00000008 | The copy will be attempted even if the destination file cannot be encrypted. | | COPY_FILE_COPY_SYMLINK
0x00000800 | If the source file is a symbolic link, the destination file is also a symbolic link pointing to the same file as the source symbolic link. | | COPY_FILE_NO_BUFFERING
0x00001000 | The copy is performed using unbuffered I/O, bypassing the system cache resources. This flag is recommended for very large file copies. It is not recommended to pause copies that are using this flag. | | COPY_FILE_REQUEST_SECURITY_PRIVILEGES
0x00002000 | The copy is attempted, specifying ACCESS_SYSTEM_SECURITY for the source file and ACCESS_SYSTEM_SECURITY \| WRITE_DAC \| WRITE_OWNER for the destination file. If these requests are denied the access request will be reduced to the highest privilege level for which access is granted. For more information see SACL Access Right. This can be used to allow the CopyFile2ProgressRoutine callback to perform operations requiring higher privileges, such as copying the security attributes for the file. | | COPY_FILE_RESUME_FROM_PAUSE
0x00004000 | The destination file is examined to see if it was copied using COPY_FILE_RESTARTABLE. If so the copy is resumed. If not the file will be fully copied. | | COPY_FILE_NO_OFFLOAD
0x00040000 | Do not attempt to use the Windows Copy Offload mechanism. This is not generally recommended. | | COPY_FILE_IGNORE_EDP_BLOCK
0x00400000 | Instead of blocking, the file should be copied and encrypted on the destination if supported by the destination file system. Supported on Windows 10 and later. | | COPY_FILE_IGNORE_SOURCE_ENCRYPTION
0x00800000 | Ignore the source file’s encrypted state. Supported on Windows 10 and later. | | COPY_FILE_DONT_REQUEST_DEST_WRITE_DAC
0x02000000 | Don't request WRITE_DAC for the destination file access. Supported on Windows 10 and later. | | COPY_FILE_OPEN_AND_COPY_REPARSE_POINT
0x00200000 | Always copy the reparse point regardless of type. It's the caller’s responsibility to understand the reparse point meaning. Supported on Windows 10, build 19041 and later. | | COPY_FILE_DIRECTORY
0x00000080 | Indicates the source file is a directory file. When provided, the source file is opened with FILE_OPEN_FOR_BACKUP_INTENT. The directory file will have its alternate data streams, reparse point info, and EAs copied like a normal file. Supported in Windows 10, build 19041 and later. | | COPY_FILE_SKIP_ALTERNATE_STREAMS
0x00008000 | Do not copy alternate data streams. Supported in Windows 10, build 19041 and later. | | COPY_FILE_DISABLE_PRE_ALLOCATION
0x04000000 | Do not preallocate the destination file size before performing the copy. Supported in Windows 10, build 19041 and later. | | COPY_FILE_ENABLE_LOW_FREE_SPACE_MODE
0x08000000 | Enable LowFreeSpace mode. No overlapped I/Os are used. ODX and SMB offload are not attempted. Supported in Windows 10, build 19041 and later. | | COPY_FILE_REQUEST_COMPRESSED_TRAFFIC
0x10000000 | Request the underlying transfer channel compress the data during the copy operation. The request may not be supported for all mediums, in which case it is ignored. The compression attributes and parameters (computational complexity, memory usage) are not configurable through this API, and are subject to change between different OS releases.

This flag was introduced in Windows 10, version 1903 and Windows Server 2022. On Windows 10, the flag is supported for files residing on SMB shares, where the negotiated SMB protocol version is SMB v3.1.1 or greater. | | COPY_FILE_ENABLE_SPARSE_COPY
0x20000000 | Enable retaining the sparse state of the file during copy. Supported in Windows 11, build 22H2 and later. | If this flag is set to TRUE during the copy operation then the copy operation is canceled. - The optional address of a callback function of type PCOPYFILE2_PROGRESS_ROUTINE that is called each time another portion of the file has been copied. This parameter can beNULL. For more information on the progress callback function, see theCopyFile2ProgressRoutine callback function. + The optional address of a callback function of type PCOPYFILE2_PROGRESS_ROUTINE that is called each time another portion of the file has been copied. This parameter can be NULL. For more information on the progress callback function, see the CopyFile2ProgressRoutine callback function. - A pointer to application-specific context information to be passed to theCopyFile2ProgressRoutine. + A pointer to application-specific context information to be passed to the CopyFile2ProgressRoutine. \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/WinBase/COPYFILE2_EXTENDED_PARAMETERS_V2.xml b/sources/Interop/Windows/Windows/um/WinBase/COPYFILE2_EXTENDED_PARAMETERS_V2.xml new file mode 100644 index 0000000000..260feb480e --- /dev/null +++ b/sources/Interop/Windows/Windows/um/WinBase/COPYFILE2_EXTENDED_PARAMETERS_V2.xml @@ -0,0 +1,42 @@ + + + + + + Contains updated, additional functionality beyond the structure for the function. + + + Contains the size of this structure, sizeof(COPYFILE2_EXTENDED_PARAMETERS_V2). + + + + Contains a combination of zero or more of these flag values. + | Value | Meaning | | ----- | ------- | | COPY_FILE_FAIL_IF_EXISTS
0x00000001 | If the destination file exists the copy operation fails immediately. If a file or directory exists with the destination name then the function call will fail with either HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS) or HRESULT_FROM_WIN32(ERROR_FILE_EXISTS). If COPY_FILE_RESUME_FROM_PAUSE is also specified then a failure is only triggered if the destination file does not have a valid restart header. | | COPY_FILE_RESTARTABLE
0x00000002 | The file is copied in a manner that can be restarted if the same source and destination filenames are used again. This is slower. | | COPY_FILE_OPEN_SOURCE_FOR_WRITE
0x00000004 | The file is copied and the source file is opened for write access. | | COPY_FILE_ALLOW_DECRYPTED_DESTINATION
0x00000008 | The copy will be attempted even if the destination file cannot be encrypted. | | COPY_FILE_COPY_SYMLINK
0x00000800 | If the source file is a symbolic link, the destination file is also a symbolic link pointing to the same file as the source symbolic link. | | COPY_FILE_NO_BUFFERING
0x00001000 | The copy is performed using unbuffered I/O, bypassing the system cache resources. This flag is recommended for very large file copies. It is not recommended to pause copies that are using this flag. | | COPY_FILE_REQUEST_SECURITY_PRIVILEGES
0x00002000 | The copy is attempted, specifying ACCESS_SYSTEM_SECURITY for the source file and ACCESS_SYSTEM_SECURITY \| WRITE_DAC \| WRITE_OWNER for the destination file. If these requests are denied the access request will be reduced to the highest privilege level for which access is granted. For more information see SACL Access Right. This can be used to allow the CopyFile2ProgressRoutine callback to perform operations requiring higher privileges, such as copying the security attributes for the file. | | COPY_FILE_RESUME_FROM_PAUSE
0x00004000 | The destination file is examined to see if it was copied using COPY_FILE_RESTARTABLE. If so the copy is resumed. If not the file will be fully copied. | | COPY_FILE_NO_OFFLOAD
0x00040000 | Do not attempt to use the Windows Copy Offload mechanism. This is not generally recommended. | | COPY_FILE_IGNORE_EDP_BLOCK
0x00400000 | Instead of blocking, the file should be copied and encrypted on the destination if supported by the destination file system. Supported on Windows 10 and later. | | COPY_FILE_IGNORE_SOURCE_ENCRYPTION
0x00800000 | Ignore the source file’s encrypted state. Supported on Windows 10 and later. | | COPY_FILE_DONT_REQUEST_DEST_WRITE_DAC
0x02000000 | Don't request WRITE_DAC for the destination file access. Supported on Windows 10 and later. | | COPY_FILE_OPEN_AND_COPY_REPARSE_POINT
0x00200000 | Always copy the reparse point regardless of type. It's the caller’s responsibility to understand the reparse point meaning. Supported on Windows 10, build 19041 and later. | | COPY_FILE_DIRECTORY
0x00000080 | Indicates the source file is a directory file. When provided, the source file is opened with FILE_OPEN_FOR_BACKUP_INTENT. The directory file will have its alternate data streams, reparse point info, and EAs copied like a normal file. Supported in Windows 10, build 19041 and later. | | COPY_FILE_SKIP_ALTERNATE_STREAMS
0x00008000 | Do not copy alternate data streams. Supported in Windows 10, build 19041 and later. | | COPY_FILE_DISABLE_PRE_ALLOCATION
0x04000000 | Do not preallocate the destination file size before performing the copy. Supported in Windows 10, build 19041 and later. | | COPY_FILE_ENABLE_LOW_FREE_SPACE_MODE
0x08000000 | Enable LowFreeSpace mode. No overlapped I/Os are used. ODX and SMB offload are not attempted. Supported in Windows 10, build 19041 and later. | | COPY_FILE_REQUEST_COMPRESSED_TRAFFIC
0x10000000 | Request the underlying transfer channel compress the data during the copy operation. The request may not be supported for all mediums, in which case it is ignored. The compression attributes and parameters (computational complexity, memory usage) are not configurable through this API, and are subject to change between different OS releases.

This flag was introduced in Windows 10, version 1903 and Windows Server 2022. On Windows 10, the flag is supported for files residing on SMB shares, where the negotiated SMB protocol version is SMB v3.1.1 or greater. | | COPY_FILE_ENABLE_SPARSE_COPY
0x20000000 | Enable retaining the sparse state of the file during copy. Supported in Windows 11, build 22H2 and later. | + + + + If this flag is set to TRUE during the copy operation then the copy operation is canceled. + + + The optional address of a callback function of type PCOPYFILE2_PROGRESS_ROUTINE that is called each time another portion of the file has been copied. This parameter can be NULL. For more information on the progress callback function, see the CopyFile2ProgressRoutine callback function. If both pProgressRoutineOld and pProgressRoutine are provided, pProgressRoutineOld takes precedence. + + + A pointer to application-specific context information to be passed to the CopyFile2ProgressRoutine. + + + + Contains a combination of zero or more of these flag values. + | Value | Meaning | | ----- | ------- | | COPY_FILE2_V2_DONT_COPY_JUNCTIONS
0x00000001 | Disable copying junctions. | + + + + Optional. The requested size (in bytes) for each I/O operation (i.e. one read/write cycle while copying the file). This may be reduced if insufficient memory is available. If zero, the default size is used. This may be ignored if ioDesiredRate is also provided + + + Optional. The requested average I/O rate, in kilobytes per second. If zero, copies are performed as fast as possible. + + + + pProgressRoutineOld. Optional. The address of an old-style callback function of type LPPROGRESS_ROUTINE that is called each time another portion of the file has been copied. This parameter can be NULL. For more information, on the progress callback function, see LPPROGRESS_ROUTINE callback. If both pProgressRoutineOld and pProgressRoutine are provided, pProgressRoutineOld takes precedence. + + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/WinBase/Windows.xml b/sources/Interop/Windows/Windows/um/WinBase/Windows.xml index 36374cd5ea..9de349d69a 100644 --- a/sources/Interop/Windows/Windows/um/WinBase/Windows.xml +++ b/sources/Interop/Windows/Windows/um/WinBase/Windows.xml @@ -24518,8 +24518,8 @@ Rights. You cannot request an access mode that conflicts with the sharing mo The path to the new current directory. This parameter may specify a relative path or a full path. In either case, the full path of the specified directory is calculated and stored as the current directory. For more information, see File Names, Paths, and Namespaces. - By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. -
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
+ By default, the name is limited to MAX_PATH characters. +
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation. See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
The final character before the null character must be a backslash ('\'). If you do not specify the backslash, it will be added for you; therefore, specify MAX_PATH-2 characters for the path unless you include the trailing backslash, in which case, specify MAX_PATH-1 characters for the path. @@ -24532,8 +24532,8 @@ Rights. You cannot request an access mode that conflicts with the sharing mo The path to the new current directory. This parameter may specify a relative path or a full path. In either case, the full path of the specified directory is calculated and stored as the current directory. For more information, see File Names, Paths, and Namespaces. - By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. -
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
+ By default, the name is limited to MAX_PATH characters. +
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation. See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
The final character before the null character must be a backslash ('\'). If you do not specify the backslash, it will be added for you; therefore, specify MAX_PATH-2 characters for the path unless you include the trailing backslash, in which case, specify MAX_PATH-1 characters for the path. @@ -24546,8 +24546,8 @@ Rights. You cannot request an access mode that conflicts with the sharing mo The path to the new current directory. This parameter may specify a relative path or a full path. In either case, the full path of the specified directory is calculated and stored as the current directory. For more information, see File Names, Paths, and Namespaces. - By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. -
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
+ By default, the name is limited to MAX_PATH characters. +
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation. See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
The final character before the null character must be a backslash ('\'). If you do not specify the backslash, it will be added for you; therefore, specify MAX_PATH-2 characters for the path unless you include the trailing backslash, in which case, specify MAX_PATH-1 characters for the path. diff --git a/sources/Interop/Windows/Windows/um/WinUser/CBTACTIVATESTRUCT.xml b/sources/Interop/Windows/Windows/um/WinUser/CBTACTIVATESTRUCT.xml index 7575f8b033..c3a1a074ad 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/CBTACTIVATESTRUCT.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/CBTACTIVATESTRUCT.xml @@ -3,7 +3,7 @@ - Contains information passed to a WH_CBT hook procedure, CBTProc, before a window is activated. + Contains information passed to a WH_CBT hook procedure, CBTProc, before a window is activated. This member is TRUE if a mouse click is causing the activation or FALSE if it is not. diff --git a/sources/Interop/Windows/Windows/um/WinUser/CBT_CREATEWNDA.xml b/sources/Interop/Windows/Windows/um/WinUser/CBT_CREATEWNDA.xml index e870bcd576..502bf70137 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/CBT_CREATEWNDA.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/CBT_CREATEWNDA.xml @@ -3,7 +3,7 @@ - Contains information passed to a WH_CBT hook procedure, CBTProc, before a window is created. + Contains information passed to a WH_CBT hook procedure, CBTProc, before a window is created. A pointer to a structure that contains initialization parameters for the window about to be created. @@ -12,7 +12,7 @@ A handle to the window whose position in the Z order precedes that of the window being created. This member can also be NULL. - Contains information passed to a WH_CBT hook procedure, CBTProc, before a window is created. + Contains information passed to a WH_CBT hook procedure, CBTProc, before a window is created. A pointer to a structure that contains initialization parameters for the window about to be created. diff --git a/sources/Interop/Windows/Windows/um/WinUser/CWPRETSTRUCT.xml b/sources/Interop/Windows/Windows/um/WinUser/CWPRETSTRUCT.xml index 2f08389ad1..f4f206e1d3 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/CWPRETSTRUCT.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/CWPRETSTRUCT.xml @@ -3,7 +3,7 @@ - Defines the message parameters passed to a WH_CALLWNDPROCRET hook procedure, CallWndRetProc. + Defines the message parameters passed to a WH_CALLWNDPROCRET hook procedure, HOOKPROC callback function. The return value of the window procedure that processed the message specified by themessage value. diff --git a/sources/Interop/Windows/Windows/um/WinUser/CWPSTRUCT.xml b/sources/Interop/Windows/Windows/um/WinUser/CWPSTRUCT.xml index c998d039fa..442a0046ba 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/CWPSTRUCT.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/CWPSTRUCT.xml @@ -3,13 +3,13 @@ - Defines the message parameters passed to a WH_CALLWNDPROC hook procedure, CallWndProc. + Defines the message parameters passed to a WH_CALLWNDPROC hook procedure, /. - Additional information about the message. The exact meaning depends on themessage value. + Additional information about the message. The exact meaning depends on the message value. - Additional information about the message. The exact meaning depends on themessage value. + Additional information about the message. The exact meaning depends on the message value. The message. diff --git a/sources/Interop/Windows/Windows/um/WinUser/DEBUGHOOKINFO.xml b/sources/Interop/Windows/Windows/um/WinUser/DEBUGHOOKINFO.xml index 79d745bd2f..421e71bda3 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/DEBUGHOOKINFO.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/DEBUGHOOKINFO.xml @@ -3,7 +3,7 @@ - Contains debugging information passed to a WH_DEBUG hook procedure, DebugProc. + Contains debugging information passed to a WH_DEBUG hook procedure, DebugProc. A handle to the thread containing the filter function. @@ -12,12 +12,12 @@ A handle to the thread that installed the debugging filter function. - The value to be passed to the hook in thelParam parameter of the DebugProc callback function. + The value to be passed to the hook in the lParam parameter of the DebugProc callback function. - The value to be passed to the hook in thewParam parameter of the DebugProc callback function. + The value to be passed to the hook in the wParam parameter of the DebugProc callback function. - The value to be passed to the hook in thenCode parameter of the DebugProc callback function. + The value to be passed to the hook in the nCode parameter of the DebugProc callback function. \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/WinUser/EVENTMSG.xml b/sources/Interop/Windows/Windows/um/WinUser/EVENTMSG.xml index 5c42bed2ea..01294a5436 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/EVENTMSG.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/EVENTMSG.xml @@ -3,7 +3,7 @@ - Contains information about a hardware message sent to the system message queue. This structure is used to store message information for the JournalPlaybackProc callback function. + Contains information about a hardware message sent to the system message queue. This structure is used to store message information for the JournalPlaybackProc callback function. The message. diff --git a/sources/Interop/Windows/Windows/um/WinUser/MOUSEHOOKSTRUCT.xml b/sources/Interop/Windows/Windows/um/WinUser/MOUSEHOOKSTRUCT.xml index 02521fbc76..eb0e5ee160 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/MOUSEHOOKSTRUCT.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/MOUSEHOOKSTRUCT.xml @@ -3,7 +3,7 @@ - Contains information about a mouse event passed to a WH_MOUSE hook procedure, MouseProc. + Contains information about a mouse event passed to a WH_MOUSE hook procedure, MouseProc. The x- and y-coordinates of the cursor, in screen coordinates. diff --git a/sources/Interop/Windows/Windows/um/WinUser/MOUSEHOOKSTRUCTEX.xml b/sources/Interop/Windows/Windows/um/WinUser/MOUSEHOOKSTRUCTEX.xml index 21668aa9de..bc7797e9ba 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/MOUSEHOOKSTRUCTEX.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/MOUSEHOOKSTRUCTEX.xml @@ -4,7 +4,7 @@ - Contains information about a mouse event passed to a WH_MOUSE hook procedure, MouseProc. + Contains information about a mouse event passed to a WH_MOUSE hook procedure, MouseProc. This is an extension of the structure that includes information about wheel movement or the use of the X button. diff --git a/sources/Interop/Windows/Windows/um/WinUser/WNDCLASSA.xml b/sources/Interop/Windows/Windows/um/WinUser/WNDCLASSA.xml index c3cc0b0dfe..80df48136e 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/WNDCLASSA.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/WNDCLASSA.xml @@ -12,7 +12,7 @@ The class style(s). This member can be any combination of the Class Styles. - A pointer to the window procedure. You must use the function to call the window procedure. For more information, see WindowProc. + A pointer to the window procedure. You must use the function to call the window procedure. For more information, see WindowProc. The number of extra bytes to allocate following the window-class structure. The system initializes the bytes to zero. @@ -112,7 +112,7 @@ The class style(s). This member can be any combination of the Class Styles. - A pointer to the window procedure. You must use the function to call the window procedure. For more information, see WindowProc. + A pointer to the window procedure. You must use the function to call the window procedure. For more information, see WindowProc. The number of extra bytes to allocate following the window-class structure. The system initializes the bytes to zero. diff --git a/sources/Interop/Windows/Windows/um/WinUser/WNDCLASSEXA.xml b/sources/Interop/Windows/Windows/um/WinUser/WNDCLASSEXA.xml index 5679dc918c..0c21a161f5 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/WNDCLASSEXA.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/WNDCLASSEXA.xml @@ -15,7 +15,7 @@ The class style(s). This member can be any combination of the Class Styles. - A pointer to the window procedure. You must use the function to call the window procedure. For more information, see WindowProc. + A pointer to the window procedure. You must use the function to call the window procedure. For more information, see WindowProc. The number of extra bytes to allocate following the window-class structure. The system initializes the bytes to zero. @@ -121,7 +121,7 @@ The class style(s). This member can be any combination of the Class Styles. - A pointer to the window procedure. You must use the function to call the window procedure. For more information, see WindowProc. + A pointer to the window procedure. You must use the function to call the window procedure. For more information, see WindowProc. The number of extra bytes to allocate following the window-class structure. The system initializes the bytes to zero. diff --git a/sources/Interop/Windows/Windows/um/WinUser/Windows.xml b/sources/Interop/Windows/Windows/um/WinUser/Windows.xml index b7d8a5e4eb..4e13f326d4 100644 --- a/sources/Interop/Windows/Windows/um/WinUser/Windows.xml +++ b/sources/Interop/Windows/Windows/um/WinUser/Windows.xml @@ -9447,8 +9447,8 @@ The vertical position of the cursor's hot spot. The width of the cursor, in pixels. The height of the cursor, in pixels. - An array of bytes that contains the bit values for the AND mask of the cursor, as in a device-dependent monochrome bitmap. - An array of bytes that contains the bit values for the XOR mask of the cursor, as in a device-dependent monochrome bitmap. + An array of bytes that contains the bit values for the AND mask of the cursor, as in a monochrome bitmap. See remarks. + An array of bytes that contains the bit values for the XOR mask of the cursor, as in a monochrome bitmap. See remarks. If the function succeeds, the return value is a handle to the cursor. If the function fails, the return value is NULL. To get extended error information, call . @@ -10282,12 +10282,12 @@ To create a colored icon at run time you can use the function, which creates a icon based on the content of an structure. A handle to the instance of the module creating the icon. - The width, in pixels, of the icon. - The height, in pixels, of the icon. - The number of planes in the XOR bitmask of the icon. + The width, in pixels, of the icon. See remarks. + The height, in pixels, of the icon. See remarks. + The number of planes in the XOR bitmask of the icon. See remarks. The number of bits-per-pixel in the XOR bitmask of the icon. - An array of bytes that contains the bit values for the AND bitmask of the icon. This bitmask describes a monochrome bitmap. - An array of bytes that contains the bit values for the XOR bitmask of the icon. This bitmask describes a monochrome or device-dependent color bitmap. + An array of bytes that contains the bit values for the AND bitmask of the icon. This bitmask describes a monochrome bitmap. See remarks. + An array of bytes that contains the bit values for the XOR bitmask of the icon. This bitmask describes a monochrome or color bitmap. See remarks. If the function succeeds, the return value is a handle to an icon. If the function fails, the return value is NULL. To get extended error information, call . @@ -10316,7 +10316,7 @@ Creates an icon or cursor from resource bits describing the icon. - The DWORD-aligned buffer pointer containing the icon or cursor resource bits. These bits are typically loaded by calls to the and functions. + The DWORD-aligned buffer pointer containing the icon (RT_ICON) or cursor (RT_CURSOR) resource bits. These bits are typically loaded by calls to the and functions. See Cursor and Icon Resources for more info on icon and cursor resource format. The size, in bytes, of the set of bits pointed to by the pbIconBits parameter. @@ -10324,7 +10324,7 @@ Indicates whether an icon or a cursor is to be created. If this parameter is TRUE, an icon is to be created. If it is FALSE, a cursor is to be created. The LOCALHEADER structure defines cursor hotspot and is the first data read from the cursor resource bits. - The version number of the icon or cursor format for the resource bits pointed to by the pbIconBits parameter. The value must be greater than or equal to 0x00020000 and less than or equal to 0x00030000. This parameter is generally set to 0x00030000. + The version number of the icon or cursor format for the resource bits pointed to by the presbits parameter. The value must be greater than or equal to 0x00020000 and less than or equal to 0x00030000. This parameter is generally set to 0x00030000. The width, in pixels, of the icon or cursor. If this parameter is zero and the Flags parameter is LR_DEFAULTSIZE, the function uses the SM_CXICON or SM_CXCURSOR system metric value to set the width. If this parameter is zero and LR_DEFAULTSIZE is not used, the function uses the actual resource width. The height, in pixels, of the icon or cursor. If this parameter is zero and the Flags parameter is LR_DEFAULTSIZE, the function uses the SM_CYICON or SM_CYCURSOR system metric value to set the height. If this parameter is zero and LR_DEFAULTSIZE is not used, the function uses the actual resource height. @@ -10362,7 +10362,7 @@ - Uses the width or height specified by the system metric values for cursors or icons, if the cxDesired or cyDesired values are set to zero. If this flag is not specified and cxDesired and cyDesired are set to zero, the function uses the actual resource size. If the resource contains multiple images, the function uses the size of the first image. + Uses the width or height specified by the system metric values for cursors or icons, if the cxDesired or cyDesired values are set to zero. If this flag is not specified and cxDesired and cyDesired are set to zero, the function uses the actual resource size. @@ -10392,7 +10392,7 @@ - Shares the icon or cursor handle if the icon or cursor is created multiple times. If LR_SHARED is not set, a second call to CreateIconFromResourceEx for the same resource will create the icon or cursor again and return a different handle.When you use this flag, the system will destroy the resource when it is no longer needed.Do not use LR_SHARED for icons or cursors that have non-standard sizes, that may change after loading, or that are loaded from a file.When loading a system icon or cursor, you must use LR_SHARED or the function will fail to load the resource. + Shares the icon or cursor handle if the icon or cursor is created multiple times. If LR_SHARED is not set, a second call to CreateIconFromResourceEx for the same resource will create the icon or cursor again and return a different handle.When you use this flag, the system will destroy the resource when it is no longer needed.Do not use LR_SHARED for icons or cursors that have non-standard sizes, that may change after loading, or that are loaded from a file. @@ -15428,7 +15428,7 @@ - If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lpRect->top to the bottom of the drawn text + If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lpRect->top to the bottom of the drawn text. If the function fails, the return value is zero. @@ -15742,7 +15742,7 @@ - If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lpRect->top to the bottom of the drawn text + If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lpRect->top to the bottom of the drawn text. If the function fails, the return value is zero. @@ -16056,7 +16056,7 @@ - If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lpRect->top to the bottom of the drawn text + If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lpRect->top to the bottom of the drawn text. If the function fails, the return value is zero. @@ -16067,10 +16067,10 @@ A handle to the device context. - A pointer to the string that specifies the text to be drawn. If the nCount parameter is -1, the string must be null-terminated. + A pointer to the string that specifies the text to be drawn. If the cchText parameter is -1, the string must be null-terminated. If uFormat includes DT_MODIFYSTRING, the function could add up to four additional characters to this string. The buffer containing the string should be large enough to accommodate these extra characters. - The length, in characters, of the string. If nCount is -1, then the lpchText parameter is assumed to be a pointer to a null-terminated string and DrawText computes the character count automatically. + The length, in characters, of the string. If cchText is -1, then the lpchText parameter is assumed to be a pointer to a null-terminated string and DrawText computes the character count automatically. A pointer to a structure that contains the rectangle (in logical coordinates) in which the text is to be formatted. The method of formatting the text. This parameter can be one or more of the following values. @@ -16381,10 +16381,10 @@ A handle to the device context. - A pointer to the string that specifies the text to be drawn. If the nCount parameter is -1, the string must be null-terminated. + A pointer to the string that specifies the text to be drawn. If the cchText parameter is -1, the string must be null-terminated. If uFormat includes DT_MODIFYSTRING, the function could add up to four additional characters to this string. The buffer containing the string should be large enough to accommodate these extra characters. - The length, in characters, of the string. If nCount is -1, then the lpchText parameter is assumed to be a pointer to a null-terminated string and DrawText computes the character count automatically. + The length, in characters, of the string. If cchText is -1, then the lpchText parameter is assumed to be a pointer to a null-terminated string and DrawText computes the character count automatically. A pointer to a structure that contains the rectangle (in logical coordinates) in which the text is to be formatted. The method of formatting the text. This parameter can be one or more of the following values. @@ -16695,10 +16695,10 @@ A handle to the device context. - A pointer to the string that specifies the text to be drawn. If the nCount parameter is -1, the string must be null-terminated. + A pointer to the string that specifies the text to be drawn. If the cchText parameter is -1, the string must be null-terminated. If uFormat includes DT_MODIFYSTRING, the function could add up to four additional characters to this string. The buffer containing the string should be large enough to accommodate these extra characters. - The length, in characters, of the string. If nCount is -1, then the lpchText parameter is assumed to be a pointer to a null-terminated string and DrawText computes the character count automatically. + The length, in characters, of the string. If cchText is -1, then the lpchText parameter is assumed to be a pointer to a null-terminated string and DrawText computes the character count automatically. A pointer to a structure that contains the rectangle (in logical coordinates) in which the text is to be formatted. The method of formatting the text. This parameter can be one or more of the following values. @@ -18246,7 +18246,7 @@ A pointer to a structure that specifies additional formatting options. This parameter can be NULL. - If the function succeeds, the return value is the text height in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lprc->top to the bottom of the drawn text + If the function succeeds, the return value is the text height in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lprc->top to the bottom of the drawn text. If the function fails, the return value is zero. @@ -18558,7 +18558,7 @@ A pointer to a structure that specifies additional formatting options. This parameter can be NULL. - If the function succeeds, the return value is the text height in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lprc->top to the bottom of the drawn text + If the function succeeds, the return value is the text height in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lprc->top to the bottom of the drawn text. If the function fails, the return value is zero. @@ -18870,7 +18870,7 @@ A pointer to a structure that specifies additional formatting options. This parameter can be NULL. - If the function succeeds, the return value is the text height in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lprc->top to the bottom of the drawn text + If the function succeeds, the return value is the text height in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lprc->top to the bottom of the drawn text. If the function fails, the return value is zero. @@ -25640,6 +25640,36 @@ TRUE indicates success, FALSE indicates failure. + + Retrieves information about the specified icon or cursor. GetIconInfoEx extends by using the newer structure. + + A handle to the icon or cursor. + To retrieve information about a standard icon or cursor, specify the identifier beginning with the IDI_ prefix or the identifier beginning with the IDC_ prefix in this parameter. + + When this method returns, contains a pointer to an structure. The function fills in the structure's members. + + TRUE indicates success, FALSE indicates failure. + + + Retrieves information about the specified icon or cursor. GetIconInfoEx extends by using the newer structure. + + A handle to the icon or cursor. + To retrieve information about a standard icon or cursor, specify the identifier beginning with the IDI_ prefix or the identifier beginning with the IDC_ prefix in this parameter. + + When this method returns, contains a pointer to an structure. The function fills in the structure's members. + + TRUE indicates success, FALSE indicates failure. + + + Retrieves information about the specified icon or cursor. GetIconInfoEx extends by using the newer structure. + + A handle to the icon or cursor. + To retrieve information about a standard icon or cursor, specify the identifier beginning with the IDI_ prefix or the identifier beginning with the IDC_ prefix in this parameter. + + When this method returns, contains a pointer to an structure. The function fills in the structure's members. + + TRUE indicates success, FALSE indicates failure. + Determines whether there are mouse-button or keyboard messages in the calling thread's message queue. @@ -25670,7 +25700,7 @@ - Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the system. + Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the calling thread. The buffer (of at least KL_NAMELENGTH characters in length) that receives the name of the input locale identifier, including the terminating null character. This will be a copy of the string provided to the function, unless layout substitution took place. For a list of the input layouts that are supplied with Windows, see Keyboard Identifiers and Input Method Editors for Windows. @@ -25681,7 +25711,7 @@ - Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the system. + Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the calling thread. The buffer (of at least KL_NAMELENGTH characters in length) that receives the name of the input locale identifier, including the terminating null character. This will be a copy of the string provided to the function, unless layout substitution took place. For a list of the input layouts that are supplied with Windows, see Keyboard Identifiers and Input Method Editors for Windows. @@ -25692,7 +25722,7 @@ - Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the system. + Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the calling thread. The buffer (of at least KL_NAMELENGTH characters in length) that receives the name of the input locale identifier, including the terminating null character. This will be a copy of the string provided to the function, unless layout substitution took place. For a list of the input layouts that are supplied with Windows, see Keyboard Identifiers and Input Method Editors for Windows. @@ -25703,7 +25733,7 @@ - Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the system. + Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the calling thread. The buffer (of at least KL_NAMELENGTH characters in length) that receives the name of the input locale identifier, including the terminating null character. This will be a copy of the string provided to the function, unless layout substitution took place. For a list of the input layouts that are supplied with Windows, see Keyboard Identifiers and Input Method Editors for Windows. @@ -25714,7 +25744,7 @@ - Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the system. + Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the calling thread. The buffer (of at least KL_NAMELENGTH characters in length) that receives the name of the input locale identifier, including the terminating null character. This will be a copy of the string provided to the function, unless layout substitution took place. For a list of the input layouts that are supplied with Windows, see Keyboard Identifiers and Input Method Editors for Windows. @@ -25725,7 +25755,7 @@ - Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the system. + Retrieves the name of the active input locale identifier (formerly called the keyboard layout) for the calling thread. The buffer (of at least KL_NAMELENGTH characters in length) that receives the name of the input locale identifier, including the terminating null character. This will be a copy of the string provided to the function, unless layout substitution took place. For a list of the input layouts that are supplied with Windows, see Keyboard Identifiers and Input Method Editors for Windows. @@ -28819,7 +28849,7 @@ - The width of the virtual screen, in pixels. The virtual screen is the bounding rectangle of all display monitors. The SM_XVIRTUALSCREEN metric is the coordinates for the left side of the virtual screen. + The width of the virtual screen, in pixels. The virtual screen is the bounding rectangle of all display monitors. The SM_XVIRTUALSCREEN metric is the coordinates for the left side of the virtual screen. @@ -29299,7 +29329,7 @@ - The height of the virtual screen, in pixels. The virtual screen is the bounding rectangle of all display monitors. The SM_YVIRTUALSCREEN metric is the coordinates for the top of the virtual screen. + The height of the virtual screen, in pixels. The virtual screen is the bounding rectangle of all display monitors. The SM_YVIRTUALSCREEN metric is the coordinates for the top of the virtual screen. @@ -29719,7 +29749,7 @@ - The coordinates for the left side of the virtual screen. The virtual screen is the bounding rectangle of all display monitors. The SM_CXVIRTUALSCREEN metric is the width of the virtual screen. + The coordinates for the left side of the virtual screen. The virtual screen is the bounding rectangle of all display monitors. The SM_CXVIRTUALSCREEN metric is the width of the virtual screen. @@ -29734,7 +29764,7 @@ - The coordinates for the top of the virtual screen. The virtual screen is the bounding rectangle of all display monitors. The SM_CYVIRTUALSCREEN metric is the height of the virtual screen. + The coordinates for the top of the virtual screen. The virtual screen is the bounding rectangle of all display monitors. The SM_CYVIRTUALSCREEN metric is the height of the virtual screen. @@ -32565,7 +32595,7 @@ The value to be converted. - Retrieves the input device type from the specifiedLPARAM value. + Retrieves the input device type from the specified LPARAM value. The value to be converted. @@ -34277,16 +34307,16 @@ - Loads the specified cursor resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+ Loads the specified cursor resource from the executable (.EXE) file associated with an application instance. +
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the cursor to be loaded. For more information, see . To load a predefined system cursor, set this parameter to NULL. - If hInstance is non-NULL, lpIconName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. - If hInstance is NULL, lpIconName specifies the identifier (beginning with the IDC_ prefix) of a predefined system cursor to load. + If hInstance is non-NULL, lpCursorName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. + If hInstance is NULL, lpCursorName specifies the identifier (beginning with the IDC_ prefix) of a predefined system cursor to load. If the function succeeds, the return value is the handle to the newly loaded cursor. @@ -34295,16 +34325,16 @@ - Loads the specified cursor resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+ Loads the specified cursor resource from the executable (.EXE) file associated with an application instance. +
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the cursor to be loaded. For more information, see . To load a predefined system cursor, set this parameter to NULL. - If hInstance is non-NULL, lpIconName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. - If hInstance is NULL, lpIconName specifies the identifier (beginning with the IDC_ prefix) of a predefined system cursor to load. + If hInstance is non-NULL, lpCursorName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. + If hInstance is NULL, lpCursorName specifies the identifier (beginning with the IDC_ prefix) of a predefined system cursor to load. If the function succeeds, the return value is the handle to the newly loaded cursor. @@ -34313,16 +34343,16 @@ - Loads the specified cursor resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+ Loads the specified cursor resource from the executable (.EXE) file associated with an application instance. +
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the cursor to be loaded. For more information, see . To load a predefined system cursor, set this parameter to NULL. - If hInstance is non-NULL, lpIconName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. - If hInstance is NULL, lpIconName specifies the identifier (beginning with the IDC_ prefix) of a predefined system cursor to load. + If hInstance is non-NULL, lpCursorName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. + If hInstance is NULL, lpCursorName specifies the identifier (beginning with the IDC_ prefix) of a predefined system cursor to load. If the function succeeds, the return value is the handle to the newly loaded cursor. @@ -34332,7 +34362,7 @@ Creates a cursor based on data contained in a file. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set).
 The source of the file data to be used to create the cursor. The data in the file must be in either .CUR or .ANI format. @@ -34364,7 +34394,7 @@ Creates a cursor based on data contained in a file. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set).
 The source of the file data to be used to create the cursor. The data in the file must be in either .CUR or .ANI format. @@ -34396,7 +34426,7 @@ Creates a cursor based on data contained in a file. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set).
 The source of the file data to be used to create the cursor. The data in the file must be in either .CUR or .ANI format. @@ -34428,7 +34458,7 @@ Creates a cursor based on data contained in a file. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set).
 The source of the file data to be used to create the cursor. The data in the file must be in either .CUR or .ANI format. @@ -34460,7 +34490,7 @@ Creates a cursor based on data contained in a file. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set).
 The source of the file data to be used to create the cursor. The data in the file must be in either .CUR or .ANI format. @@ -34492,7 +34522,7 @@ Creates a cursor based on data contained in a file. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_LOADFROMFILE flags set).
 The source of the file data to be used to create the cursor. The data in the file must be in either .CUR or .ANI format. @@ -34524,15 +34554,15 @@ Loads the specified cursor resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the cursor to be loaded. For more information, see . To load a predefined system cursor, set this parameter to NULL. - If hInstance is non-NULL, lpIconName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. - If hInstance is NULL, lpIconName specifies the identifier begin with the IDC_ prefix of a predefined system cursor to load. + If hInstance is non-NULL, lpCursorName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. + If hInstance is NULL, lpCursorName specifies the identifier that begins with the IDC_ prefix of a predefined system cursor to load. If the function succeeds, the return value is the handle to the newly loaded cursor. @@ -34542,15 +34572,15 @@ Loads the specified cursor resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the cursor to be loaded. For more information, see . To load a predefined system cursor, set this parameter to NULL. - If hInstance is non-NULL, lpIconName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. - If hInstance is NULL, lpIconName specifies the identifier begin with the IDC_ prefix of a predefined system cursor to load. + If hInstance is non-NULL, lpCursorName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. + If hInstance is NULL, lpCursorName specifies the identifier that begins with the IDC_ prefix of a predefined system cursor to load. If the function succeeds, the return value is the handle to the newly loaded cursor. @@ -34560,15 +34590,15 @@ Loads the specified cursor resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the cursor to be loaded. For more information, see . To load a predefined system cursor, set this parameter to NULL. - If hInstance is non-NULL, lpIconName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. - If hInstance is NULL, lpIconName specifies the identifier begin with the IDC_ prefix of a predefined system cursor to load. + If hInstance is non-NULL, lpCursorName specifies the cursor resource either by name or ordinal. This ordinal must be packaged by using the macro. + If hInstance is NULL, lpCursorName specifies the identifier that begins with the IDC_ prefix of a predefined system cursor to load. If the function succeeds, the return value is the handle to the newly loaded cursor. @@ -34578,7 +34608,7 @@ Loads the specified icon resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the icon to be loaded. For more information, see . @@ -34596,7 +34626,7 @@ Loads the specified icon resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the icon to be loaded. For more information, see . @@ -34614,7 +34644,7 @@ Loads the specified icon resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the icon to be loaded. For more information, see . @@ -34632,7 +34662,7 @@ Loads the specified icon resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the icon to be loaded. For more information, see . @@ -34650,7 +34680,7 @@ Loads the specified icon resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the icon to be loaded. For more information, see . @@ -34668,7 +34698,7 @@ Loads the specified icon resource from the executable (.exe) file associated with an application instance. -
[!NOTE] This function has been superseded by the function with LR_DEFAULTSIZE and LR_SHARED flags set.
+
[!NOTE] This function has been superseded by the function (with LR_DEFAULTSIZE and LR_SHARED flags set).
 A handle to the module of either a DLL or executable (.exe) file that contains the icon to be loaded. For more information, see . @@ -34691,13 +34721,15 @@ The image to be loaded. - If the hinst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, lpszName specifies the image resource in the hinst module. - If the image resource is to be loaded by name from the module, the lpszName parameter is a pointer to a null-terminated string that contains the name of the image resource. + If the hInst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, name specifies the image resource in the hInst module. + If the image resource is to be loaded by name from the module, the name parameter is a pointer to a null-terminated string that contains the name of the image resource. If the image resource is to be loaded by ordinal from the module, use the macro to convert the image ordinal into a form that can be passed to the LoadImage function. + If the hInst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the name specifies the predefined image to load. + The predefined image identifiers are defined in Winuser.h and have the following prefixes: + | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps. Use the macro to pass these. | | OIC_ | OEM icons. Use the macro to pass these. | | OCR_ | OEM cursors. Use the macro to pass these. | | IDI_ | Standard icons | | IDC_ | Standard cursors | + To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the name parameter, NULL as the hInst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. + If the hInst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, name is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. For more information, see the Remarks section below. - If the hinst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the lpszName specifies the predefined image to load. The predefined image identifiers are defined in Winuser.h and have the following prefixes: - | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps | | OIC_ | OEM icons | | OCR_ | OEM cursors | | IDI_ | Standard icons | | IDC_ | Standard cursors |   To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the lpszName parameter, NULL as the hinst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. - If the hinst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, lpszName is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. The type of image to be loaded. @@ -34771,7 +34803,7 @@ - Loads the standalone image from the file specified by lpszName (icon, cursor, or bitmap file). + Loads the standalone image from the file specified by name (icon, cursor, or bitmap file). @@ -34863,13 +34895,15 @@ The image to be loaded. - If the hinst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, lpszName specifies the image resource in the hinst module. - If the image resource is to be loaded by name from the module, the lpszName parameter is a pointer to a null-terminated string that contains the name of the image resource. + If the hInst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, name specifies the image resource in the hInst module. + If the image resource is to be loaded by name from the module, the name parameter is a pointer to a null-terminated string that contains the name of the image resource. If the image resource is to be loaded by ordinal from the module, use the macro to convert the image ordinal into a form that can be passed to the LoadImage function. + If the hInst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the name specifies the predefined image to load. + The predefined image identifiers are defined in Winuser.h and have the following prefixes: + | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps. Use the macro to pass these. | | OIC_ | OEM icons. Use the macro to pass these. | | OCR_ | OEM cursors. Use the macro to pass these. | | IDI_ | Standard icons | | IDC_ | Standard cursors | + To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the name parameter, NULL as the hInst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. + If the hInst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, name is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. For more information, see the Remarks section below. - If the hinst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the lpszName specifies the predefined image to load. The predefined image identifiers are defined in Winuser.h and have the following prefixes: - | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps | | OIC_ | OEM icons | | OCR_ | OEM cursors | | IDI_ | Standard icons | | IDC_ | Standard cursors |   To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the lpszName parameter, NULL as the hinst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. - If the hinst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, lpszName is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. The type of image to be loaded. @@ -34943,7 +34977,7 @@ - Loads the standalone image from the file specified by lpszName (icon, cursor, or bitmap file). + Loads the standalone image from the file specified by name (icon, cursor, or bitmap file). @@ -35035,13 +35069,15 @@ The image to be loaded. - If the hinst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, lpszName specifies the image resource in the hinst module. - If the image resource is to be loaded by name from the module, the lpszName parameter is a pointer to a null-terminated string that contains the name of the image resource. + If the hInst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, name specifies the image resource in the hInst module. + If the image resource is to be loaded by name from the module, the name parameter is a pointer to a null-terminated string that contains the name of the image resource. If the image resource is to be loaded by ordinal from the module, use the macro to convert the image ordinal into a form that can be passed to the LoadImage function. + If the hInst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the name specifies the predefined image to load. + The predefined image identifiers are defined in Winuser.h and have the following prefixes: + | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps. Use the macro to pass these. | | OIC_ | OEM icons. Use the macro to pass these. | | OCR_ | OEM cursors. Use the macro to pass these. | | IDI_ | Standard icons | | IDC_ | Standard cursors | + To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the name parameter, NULL as the hInst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. + If the hInst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, name is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. For more information, see the Remarks section below. - If the hinst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the lpszName specifies the predefined image to load. The predefined image identifiers are defined in Winuser.h and have the following prefixes: - | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps | | OIC_ | OEM icons | | OCR_ | OEM cursors | | IDI_ | Standard icons | | IDC_ | Standard cursors |   To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the lpszName parameter, NULL as the hinst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. - If the hinst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, lpszName is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. The type of image to be loaded. @@ -35115,7 +35151,7 @@ - Loads the standalone image from the file specified by lpszName (icon, cursor, or bitmap file). + Loads the standalone image from the file specified by name (icon, cursor, or bitmap file). @@ -35207,13 +35243,15 @@ The image to be loaded. - If the hinst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, lpszName specifies the image resource in the hinst module. - If the image resource is to be loaded by name from the module, the lpszName parameter is a pointer to a null-terminated string that contains the name of the image resource. + If the hInst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, name specifies the image resource in the hInst module. + If the image resource is to be loaded by name from the module, the name parameter is a pointer to a null-terminated string that contains the name of the image resource. If the image resource is to be loaded by ordinal from the module, use the macro to convert the image ordinal into a form that can be passed to the LoadImage function. + If the hInst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the name specifies the predefined image to load. + The predefined image identifiers are defined in Winuser.h and have the following prefixes: + | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps. Use the macro to pass these. | | OIC_ | OEM icons. Use the macro to pass these. | | OCR_ | OEM cursors. Use the macro to pass these. | | IDI_ | Standard icons | | IDC_ | Standard cursors | + To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the name parameter, NULL as the hInst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. + If the hInst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, name is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. For more information, see the Remarks section below. - If the hinst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the lpszName specifies the predefined image to load. The predefined image identifiers are defined in Winuser.h and have the following prefixes: - | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps | | OIC_ | OEM icons | | OCR_ | OEM cursors | | IDI_ | Standard icons | | IDC_ | Standard cursors |   To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the lpszName parameter, NULL as the hinst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. - If the hinst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, lpszName is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. The type of image to be loaded. @@ -35287,7 +35325,7 @@ - Loads the standalone image from the file specified by lpszName (icon, cursor, or bitmap file). + Loads the standalone image from the file specified by name (icon, cursor, or bitmap file). @@ -35379,13 +35417,15 @@ The image to be loaded. - If the hinst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, lpszName specifies the image resource in the hinst module. - If the image resource is to be loaded by name from the module, the lpszName parameter is a pointer to a null-terminated string that contains the name of the image resource. + If the hInst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, name specifies the image resource in the hInst module. + If the image resource is to be loaded by name from the module, the name parameter is a pointer to a null-terminated string that contains the name of the image resource. If the image resource is to be loaded by ordinal from the module, use the macro to convert the image ordinal into a form that can be passed to the LoadImage function. + If the hInst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the name specifies the predefined image to load. + The predefined image identifiers are defined in Winuser.h and have the following prefixes: + | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps. Use the macro to pass these. | | OIC_ | OEM icons. Use the macro to pass these. | | OCR_ | OEM cursors. Use the macro to pass these. | | IDI_ | Standard icons | | IDC_ | Standard cursors | + To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the name parameter, NULL as the hInst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. + If the hInst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, name is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. For more information, see the Remarks section below. - If the hinst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the lpszName specifies the predefined image to load. The predefined image identifiers are defined in Winuser.h and have the following prefixes: - | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps | | OIC_ | OEM icons | | OCR_ | OEM cursors | | IDI_ | Standard icons | | IDC_ | Standard cursors |   To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the lpszName parameter, NULL as the hinst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. - If the hinst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, lpszName is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. The type of image to be loaded. @@ -35459,7 +35499,7 @@ - Loads the standalone image from the file specified by lpszName (icon, cursor, or bitmap file). + Loads the standalone image from the file specified by name (icon, cursor, or bitmap file). @@ -35551,13 +35591,15 @@ The image to be loaded. - If the hinst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, lpszName specifies the image resource in the hinst module. - If the image resource is to be loaded by name from the module, the lpszName parameter is a pointer to a null-terminated string that contains the name of the image resource. + If the hInst parameter is non-NULL and the fuLoad parameter omits LR_LOADFROMFILE, name specifies the image resource in the hInst module. + If the image resource is to be loaded by name from the module, the name parameter is a pointer to a null-terminated string that contains the name of the image resource. If the image resource is to be loaded by ordinal from the module, use the macro to convert the image ordinal into a form that can be passed to the LoadImage function. + If the hInst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the name specifies the predefined image to load. + The predefined image identifiers are defined in Winuser.h and have the following prefixes: + | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps. Use the macro to pass these. | | OIC_ | OEM icons. Use the macro to pass these. | | OCR_ | OEM cursors. Use the macro to pass these. | | IDI_ | Standard icons | | IDC_ | Standard cursors | + To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the name parameter, NULL as the hInst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. + If the hInst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, name is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. For more information, see the Remarks section below. - If the hinst parameter is NULL and the fuLoad parameter omits the LR_LOADFROMFILE value, the lpszName specifies the predefined image to load. The predefined image identifiers are defined in Winuser.h and have the following prefixes: - | Prefix | Meaning | |---|---| | OBM_ | OEM bitmaps | | OIC_ | OEM icons | | OCR_ | OEM cursors | | IDI_ | Standard icons | | IDC_ | Standard cursors |   To pass OEM image identifiers constants to the LoadImage function, use the macro. For example, to load the OCR_NORMAL cursor, pass MAKEINTRESOURCE(OCR_NORMAL) as the lpszName parameter, NULL as the hinst parameter, and LR_SHARED as one of the flags to the fuLoad parameter. - If the hinst parameter is NULL and the fuLoad parameter includes the LR_LOADFROMFILE value, lpszName is the name of the file that contains the standalone resource (icon, cursor, or bitmap file), - for example, c:\myicon.ico. The type of image to be loaded. @@ -35631,7 +35673,7 @@ - Loads the standalone image from the file specified by lpszName (icon, cursor, or bitmap file). + Loads the standalone image from the file specified by name (icon, cursor, or bitmap file). @@ -35764,7 +35806,7 @@ - Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. + Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. @@ -35897,7 +35939,7 @@ - Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. + Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. @@ -36030,7 +36072,7 @@ - Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. + Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. @@ -36163,7 +36205,7 @@ - Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. + Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. @@ -36296,7 +36338,7 @@ - Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. + Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. @@ -36429,7 +36471,7 @@ - Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. + Prior to Windows 8: Prevents a ShellProc hook procedure from receiving an HSHELL_LANGUAGE hook code when the new input locale identifier is loaded. This value is typically used when an application loads multiple input locale identifiers one after another. Applying this value to all but the last input locale identifier delays the shell's processing until all input locale identifiers have been added.Beginning in Windows 8: In this scenario, the last input locale identifier is set for the entire system. @@ -46681,7 +46723,6 @@ Events. -
[!WARNING]SetAdditionalForegroundBoostProcesses is a limited access feature. Contact for more information.
SetAdditionalForegroundBoostProcesses is a performance assist API to help applications with a multi-process application model where multiple processes contribute to a foreground experience, either as data or rendering. Examples include browsers (with the browser manager or frame, tabs, plugins, etc. hosted in different processes) and IDEs (which spawn processes for compilation and other tasks). Applications can use this API to provide a foreground priority boost to worker processes that help support the main application. Such applications can have a uniform priority boost applied to all of their constituent processes when the application's top level window is in the foreground. @@ -48880,7 +48921,7 @@ Events. Sets the cursor shape. A handle to the cursor. - The cursor must have been created by either the or the CreateIconIndirect function, or loaded by either the or the function. + The cursor must have been created by either the or the function, or loaded by either the or the function. If this parameter is NULL, the cursor is removed from the screen. @@ -52213,7 +52254,7 @@ Events. - Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the CallWndProc hook procedure. + Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the / hook procedure. @@ -52228,7 +52269,7 @@ Events. - Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the CallWndRetProc hook procedure. + Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the [HOOKPROC callback function](nc-winuser-hookproc.md) hook procedure. @@ -52243,7 +52284,7 @@ Events. - Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. + Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. @@ -52258,7 +52299,7 @@ Events. - Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. + Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. @@ -52273,7 +52314,7 @@ Events. - Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. + Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. @@ -52288,7 +52329,7 @@ Events. - Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. + Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. @@ -52304,8 +52345,8 @@ Events. -
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. +
[!WARNING]Windows 11 and newer: Journaling hook APIs are not supported. We recommend using the TextInput API instead.
+ Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. @@ -52322,8 +52363,8 @@ Events. -
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. +
[!WARNING]Windows 11 and newer: Journaling hook APIs are not supported. We recommend using the TextInput API instead.
+ Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. @@ -52339,7 +52380,7 @@ Events. - Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. + Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. @@ -52354,7 +52395,7 @@ Events. - Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. + Installs a hook procedure that monitors low-level keyboard input events. For more information, see the [LowLevelKeyboardProc](/windows/win32/winmsg/lowlevelkeyboardproc) hook procedure. @@ -52369,7 +52410,7 @@ Events. - Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. + Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. @@ -52384,7 +52425,7 @@ Events. - Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. + Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. @@ -52399,7 +52440,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. @@ -52414,7 +52455,7 @@ Events. - Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. + Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. @@ -52429,7 +52470,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. @@ -52463,7 +52504,7 @@ Events. - Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the CallWndProc hook procedure. + Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the / hook procedure. @@ -52478,7 +52519,7 @@ Events. - Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the CallWndRetProc hook procedure. + Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the [HOOKPROC callback function](nc-winuser-hookproc.md) hook procedure. @@ -52493,7 +52534,7 @@ Events. - Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. + Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. @@ -52508,7 +52549,7 @@ Events. - Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. + Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. @@ -52523,7 +52564,7 @@ Events. - Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. + Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. @@ -52538,7 +52579,7 @@ Events. - Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. + Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. @@ -52554,8 +52595,8 @@ Events. -
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. +
[!WARNING]Windows 11 and newer: Journaling hook APIs are not supported. We recommend using the TextInput API instead.
+ Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. @@ -52572,8 +52613,8 @@ Events. -
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. +
[!WARNING]Windows 11 and newer: Journaling hook APIs are not supported. We recommend using the TextInput API instead.
+ Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. @@ -52589,7 +52630,7 @@ Events. - Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. + Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. @@ -52604,7 +52645,7 @@ Events. - Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. + Installs a hook procedure that monitors low-level keyboard input events. For more information, see the [LowLevelKeyboardProc](/windows/win32/winmsg/lowlevelkeyboardproc) hook procedure. @@ -52619,7 +52660,7 @@ Events. - Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. + Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. @@ -52634,7 +52675,7 @@ Events. - Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. + Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. @@ -52649,7 +52690,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. @@ -52664,7 +52705,7 @@ Events. - Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. + Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. @@ -52679,7 +52720,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. @@ -52713,7 +52754,7 @@ Events. - Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the CallWndProc hook procedure. + Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the / hook procedure. @@ -52728,7 +52769,7 @@ Events. - Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the CallWndRetProc hook procedure. + Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the [HOOKPROC callback function](nc-winuser-hookproc.md) hook procedure. @@ -52743,7 +52784,7 @@ Events. - Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. + Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. @@ -52758,7 +52799,7 @@ Events. - Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. + Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. @@ -52773,7 +52814,7 @@ Events. - Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. + Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. @@ -52788,7 +52829,7 @@ Events. - Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. + Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. @@ -52804,8 +52845,8 @@ Events. -
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. +
[!WARNING]Windows 11 and newer: Journaling hook APIs are not supported. We recommend using the TextInput API instead.
+ Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. @@ -52822,8 +52863,8 @@ Events. -
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. +
[!WARNING]Windows 11 and newer: Journaling hook APIs are not supported. We recommend using the TextInput API instead.
+ Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. @@ -52839,7 +52880,7 @@ Events. - Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. + Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. @@ -52854,7 +52895,7 @@ Events. - Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. + Installs a hook procedure that monitors low-level keyboard input events. For more information, see the [LowLevelKeyboardProc](/windows/win32/winmsg/lowlevelkeyboardproc) hook procedure. @@ -52869,7 +52910,7 @@ Events. - Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. + Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. @@ -52884,7 +52925,7 @@ Events. - Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. + Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. @@ -52899,7 +52940,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. @@ -52914,7 +52955,7 @@ Events. - Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. + Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. @@ -52929,7 +52970,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. @@ -52963,7 +53004,7 @@ Events. - Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the CallWndProc hook procedure. + Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the / hook procedure. @@ -52978,7 +53019,7 @@ Events. - Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the CallWndRetProc hook procedure. + Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the HOOKPROC callback function hook procedure. @@ -52993,7 +53034,7 @@ Events. - Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. + Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. @@ -53008,7 +53049,7 @@ Events. - Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. + Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. @@ -53023,7 +53064,7 @@ Events. - Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. + Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. @@ -53038,7 +53079,7 @@ Events. - Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. + Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. @@ -53055,7 +53096,7 @@ Events.
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. + Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. @@ -53073,7 +53114,7 @@ Events.
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. + Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. @@ -53089,7 +53130,7 @@ Events. - Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. + Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. @@ -53104,7 +53145,7 @@ Events. - Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. + Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. @@ -53119,7 +53160,7 @@ Events. - Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. + Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. @@ -53134,7 +53175,7 @@ Events. - Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. + Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. @@ -53149,7 +53190,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. @@ -53164,7 +53205,7 @@ Events. - Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. + Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. @@ -53179,7 +53220,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. @@ -53213,7 +53254,7 @@ Events. - Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the CallWndProc hook procedure. + Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the / hook procedure. @@ -53228,7 +53269,7 @@ Events. - Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the CallWndRetProc hook procedure. + Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the HOOKPROC callback function hook procedure. @@ -53243,7 +53284,7 @@ Events. - Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. + Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. @@ -53258,7 +53299,7 @@ Events. - Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. + Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. @@ -53273,7 +53314,7 @@ Events. - Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. + Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. @@ -53288,7 +53329,7 @@ Events. - Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. + Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. @@ -53305,7 +53346,7 @@ Events.
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. + Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. @@ -53323,7 +53364,7 @@ Events.
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. + Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. @@ -53339,7 +53380,7 @@ Events. - Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. + Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. @@ -53354,7 +53395,7 @@ Events. - Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. + Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. @@ -53369,7 +53410,7 @@ Events. - Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. + Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. @@ -53384,7 +53425,7 @@ Events. - Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. + Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. @@ -53399,7 +53440,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. @@ -53414,7 +53455,7 @@ Events. - Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. + Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. @@ -53429,7 +53470,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. @@ -53463,7 +53504,7 @@ Events. - Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the CallWndProc hook procedure. + Installs a hook procedure that monitors messages before the system sends them to the destination window procedure. For more information, see the / hook procedure. @@ -53478,7 +53519,7 @@ Events. - Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the CallWndRetProc hook procedure. + Installs a hook procedure that monitors messages after they have been processed by the destination window procedure. For more information, see the HOOKPROC callback function hook procedure. @@ -53493,7 +53534,7 @@ Events. - Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. + Installs a hook procedure that receives notifications useful to a CBT application. For more information, see the CBTProc hook procedure. @@ -53508,7 +53549,7 @@ Events. - Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. + Installs a hook procedure useful for debugging other hook procedures. For more information, see the DebugProc hook procedure. @@ -53523,7 +53564,7 @@ Events. - Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. + Installs a hook procedure that will be called when the application's foreground thread is about to become idle. This hook is useful for performing low priority tasks during idle time. For more information, see the ForegroundIdleProc hook procedure. @@ -53538,7 +53579,7 @@ Events. - Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. + Installs a hook procedure that monitors messages posted to a message queue. For more information, see the GetMsgProc hook procedure. @@ -53555,7 +53596,7 @@ Events.
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. + Installs a hook procedure that posts messages previously recorded by a WH_JOURNALRECORD hook procedure. For more information, see the JournalPlaybackProc hook procedure. @@ -53573,7 +53614,7 @@ Events.
[!WARNING] Journaling Hooks APIs are unsupported starting in Windows 11 and will be removed in a future release. Because of this, we highly recommend calling the TextInput API instead.
- Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. + Installs a hook procedure that records input messages posted to the system message queue. This hook is useful for recording macros. For more information, see the JournalRecordProc hook procedure. @@ -53589,7 +53630,7 @@ Events. - Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. + Installs a hook procedure that monitors keystroke messages. For more information, see the KeyboardProc hook procedure. @@ -53604,7 +53645,7 @@ Events. - Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. + Installs a hook procedure that monitors low-level keyboard input events. For more information, see the LowLevelKeyboardProc hook procedure. @@ -53619,7 +53660,7 @@ Events. - Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. + Installs a hook procedure that monitors mouse messages. For more information, see the MouseProc hook procedure. @@ -53634,7 +53675,7 @@ Events. - Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. + Installs a hook procedure that monitors low-level mouse input events. For more information, see the LowLevelMouseProc hook procedure. @@ -53649,7 +53690,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. For more information, see the MessageProc hook procedure. @@ -53664,7 +53705,7 @@ Events. - Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. + Installs a hook procedure that receives notifications useful to shell applications. For more information, see the ShellProc hook procedure. @@ -53679,7 +53720,7 @@ Events. - Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. + Installs a hook procedure that monitors messages generated as a result of an input event in a dialog box, message box, menu, or scroll bar. The hook procedure monitors these messages for all applications in the same desktop as the calling thread. For more information, see the SysMsgProc hook procedure. @@ -54180,7 +54221,7 @@ Events. A pointer to a 256-byte array that contains the current keyboard state. Each element (byte) in the array contains the state of one key. If the high-order bit of a byte is set, the key is down (pressed). The low bit, if set, indicates that the key is toggled on. In this function, only the toggle bit of the CAPS LOCK key is relevant. The toggle state of the NUM LOCK and SCROLL LOCK keys is ignored. - The buffer that receives the translated character or characters. The low-order byte contains first character and the high-order byte contains second character, if present. + A pointer to the buffer that receives the translated character (or two characters packed into a single WORD value, where the low-order byte contains the first character and the high-order byte contains the second character). This parameter must be 1 if a menu is active, or 0 otherwise. The return value is one of the following values. @@ -54233,7 +54274,7 @@ Events. A pointer to a 256-byte array that contains the current keyboard state. Each element (byte) in the array contains the state of one key. If the high-order bit of a byte is set, the key is down (pressed). The low bit, if set, indicates that the key is toggled on. In this function, only the toggle bit of the CAPS LOCK key is relevant. The toggle state of the NUM LOCK and SCOLL LOCK keys is ignored. - A pointer to the buffer that receives the translated character or characters. The low-order byte contains first character and the high-order byte contains second character, if present. + A pointer to the buffer that receives the translated character (or two characters packed into a single WORD value, where the low-order byte contains the first character and the high-order byte contains the second character). This parameter must be 1 if a menu is active, zero otherwise. Input locale identifier to use to translate the code. This parameter can be any input locale identifier previously returned by the function. diff --git a/sources/Interop/Windows/Windows/um/amvideo/AM_FRAMESTEP_STEP.xml b/sources/Interop/Windows/Windows/um/amvideo/AM_FRAMESTEP_STEP.xml index 4b35c88cb9..a6f6586a78 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/AM_FRAMESTEP_STEP.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/AM_FRAMESTEP_STEP.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the number of frames to step. diff --git a/sources/Interop/Windows/Windows/um/amvideo/ANALOGVIDEOINFO.xml b/sources/Interop/Windows/Windows/um/amvideo/ANALOGVIDEOINFO.xml index a42e264b55..b4dc5336b8 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/ANALOGVIDEOINFO.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/ANALOGVIDEOINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ANALOGVIDEOINFO structure maintains information about the format of the analog video signal. diff --git a/sources/Interop/Windows/Windows/um/amvideo/IDirectDrawVideo.xml b/sources/Interop/Windows/Windows/um/amvideo/IDirectDrawVideo.xml index 1101022a74..81dcc00ca4 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/IDirectDrawVideo.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/IDirectDrawVideo.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CanUseOverlayStretch method determines whether the renderer will check overlay restrictions. Pointer to a value indicating whether the renderer can use overlay restrictions. OATRUE indicates the renderer will check overlay restrictions; OAFALSE indicates it will not. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CanUseScanLine method determines whether the renderer will check the current scan line when drawing. Pointer to a value indicating whether the renderer will use scan line information. OATRUE indicates the renderer will check the current scan line when drawing; OAFALSE indicates it will not. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCaps method retrieves a DirectDraw-defined DDCAPS structure containing the hardware capabilities. Pointer to a DDCAPS structure containing the hardware capabilities. @@ -28,7 +28,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDirectDraw method retrieves the IDirectDraw interface. Address of a pointer to the IDirectDraw interface. @@ -36,7 +36,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetEmulatedCaps method retrieves a DirectDraw-defined DDCAPS structure containing the emulated capabilities. Pointer to a DDCAPS structure containing the emulated capabilities. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetFourCCCodes method retrieves the multimedia format type. Pointer to the number of FOURCC codes in the pCodes array. @@ -53,7 +53,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSurfaceDesc method retrieves a DDSURFACEDESC structure describing the current DirectDraw surface. Pointer to a DDSURFACEDESC structure describing the current DirectDraw surface. @@ -61,7 +61,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSurfaceType method retrieves the actual surface type as a DirectShow DirectDraw Surface (AMDDS) definition. @@ -133,7 +133,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSwitches method retrieves the surface types that the renderer is allowed to use. @@ -205,14 +205,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDefault method makes the current property settings the global default. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDirectDraw method passes the IDirectDraw interface to a loaded driver. Pointer to the IDirectDraw interface to be passed. @@ -220,7 +220,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetSwitches method sets the surface types that the renderer is allowed to use. @@ -292,7 +292,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UseOverlayStretch method determines whether the renderer should check overlay stretch limitations. Value specifying whether the renderer checks overlay stretching. Set to OATRUE for the renderer to check overlay stretching; otherwise, set to OAFALSE. @@ -300,7 +300,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UseScanLine method determines whether the renderer should check the current scan line when drawing a video. Long integer value that specifies whether or not to use the scan line information. Set to OATRUE to use scan line information or OAFALSE to ignore it. @@ -308,7 +308,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UseWhenFullScreen method determines whether DirectShow should change display mode when going to full-screen mode. Value specifying whether to change the display mode. Set to OATRUE to cause the renderer to use DirectShow in full-screen mode; otherwise, set to OAFALSE. @@ -316,7 +316,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The WillUseFullScreen method determines whether DirectShow will change display mode when going to full-screen mode. Pointer to a value indicating whether DirectShow will use DirectX in full-screen mode. OATRUE indicates it will use full-screen mode; OAFALSE indicates it will not. @@ -324,7 +324,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDirectDrawVideo interface queries the Video Renderer filter about DirectDraw surfaces and hardware capabilities. Applications can use this interface to control what DirectDraw features the Video Renderer will take advantage of. For example, if you are positive that you don't want the Video Renderer to use a hardware overlay you can disable its use via the method.
diff --git a/sources/Interop/Windows/Windows/um/amvideo/IFullScreenVideoEx.xml b/sources/Interop/Windows/Windows/um/amvideo/IFullScreenVideoEx.xml index 191ae6b50f..013761f235 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/IFullScreenVideoEx.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/IFullScreenVideoEx.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CountModes method retrieves the number of display modes that the Full Screen Renderer supports. Pointer to the returned mode count. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAcceleratorTable method retrieves the accelerator table currently being used to translate keyboard messages. The Full Screen Renderer filter does not support this method. Pointer to a variable that receives a window handle. The window receives translated messages. @@ -54,7 +54,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCaption method retrieves the caption associated with the full-screen window. Pointer to a BSTR that receives the caption. @@ -107,7 +107,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetClipFactor method retrieves the clip factor, which determines how much of the video the Full Screen Renderer is allowed to clip. For example, if the clip factor is 25, the Full Screen Renderer can clip up to 25% of the video. Pointer to a variable the receives the clip factor. @@ -148,7 +148,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentMode method retrieves the current display mode. Pointer to a variable that receives the index of the current video mode. Pass this index to the method to obtain information about this mode, including the width, height, and bit depth. @@ -201,7 +201,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMessageDrain method retrieves the window that receives mouse and keyboard messages, if any. Pointer to a variable that receives the handle of the window. If no window has been designated to receive messages, this parameter receives the value NULL. @@ -242,7 +242,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetModeInfo method retrieves information about a specified display mode supported by the Full Screen Renderer filter. Index of the display mode. @@ -310,7 +310,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMonitor method queries which monitor the Full Screen Renderer is using. The Full Screen Renderer only supports the primary monitor, so the returned value is always zero. Pointer to a variable that receives the index of the monitor. @@ -351,7 +351,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The HideOnDeactivate method . Depending on the setting, the full-screen video window is either minimized or hidden. If it is minimized, it appears as an icon in the task bar; otherwise, it does not. @@ -407,7 +407,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsHideOnDeactivate method indicates the behavior when the user switches to another application. Depending on the setting, the full-screen video window is either minimized or hidden. If it is minimized, it appears as an icon in the task bar; otherwise, it does not. @@ -446,7 +446,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsKeepPixelAspectRatio method queries whether the pixel aspect ratio is maintained. The Full Screen Renderer filter does not support this method; it always maintains the pixel aspect ratio. Pointer to a variable that receives the value OATRUE or OAFALSE. @@ -454,7 +454,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsModeAvailable method queries whether a specified display mode is available. Index of the display mode. @@ -506,7 +506,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsModeEnabled method queries whether a specified display mode is enabled. Index of the display mode to query. @@ -558,7 +558,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The KeepPixelAspectRatio method specifies whether to maintain the pixel aspect ratio. The Full Screen Renderer filter does not support this method; it always maintains the pixel aspect ratio. Specifies whether to maintain the aspect ratio. The value must be OATRUE or OAFALSE. @@ -566,7 +566,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetAcceleratorTable method specifies an accelerator table that will be used to translate keyboard messages. The Full Screen Renderer filter does not support this method. Handle of the window that will receive the translated messages. @@ -575,7 +575,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetCaption method sets the caption associated with the full-screen window. String containing the caption. @@ -616,7 +616,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetClipFactor method specifies the clip factor, which determines how much of the video the Full Screen Renderer is allowed to clip. For example, suppose the display mode is 320 x 200 and the video is 352 x 288 pixels. Assuming the decoder cannot shrink the video, the display will clip about 25 percent of the image. The clip factor specifies the upper range that is permitted. The default value is 25%. @@ -640,14 +640,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDefault method saves the current settings. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetEnabled method enables or disables a specified display mode. Index of the display mode to enable or disable. @@ -703,7 +703,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMessageDrain method specifies a window to receive mouse and keyboard messages from the video window. Specifies a handle to the message-drain window. @@ -711,7 +711,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMonitor method specifies which monitor to use. The Full Screen Renderer only supports the primary monitor, however, so this method is not useful in the current implementation. Specifies the index of the monitor to use. Must be zero in the current implementation. @@ -751,7 +751,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFullScreenVideoEx interface is implemented on the Full Screen Renderer filter, which provides full-screen video rendering on older hardware. Newer video cards can stretch the video efficiently enough that the Full Screen Renderer is not required. Therefore, both the filter and this interface are now deprecated. diff --git a/sources/Interop/Windows/Windows/um/amvideo/IQualProp.xml b/sources/Interop/Windows/Windows/um/amvideo/IQualProp.xml index 5233941534..309693813c 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/IQualProp.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/IQualProp.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_AvgFrameRate method retrieves the actual average frame rate since streaming started. Pointer to a variable that receives the actual number of frames per second, multiplied by 100. For example, an average frame rate of 30 frames per second will be represented as 3000. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_AvgSyncOffset method retrieves the average time difference between when the video frames should have been displayed and when they actually were. Pointer to the time difference, expressed in milliseconds. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_DevSyncOffset method retrieves the average time difference between when the video frames should have been displayed and when they actually were. This method is the same as the method except that the value returned is calculated as a standard deviation rather than as a simple average. Pointer to a value denoting the accuracy of the video frames displayed. @@ -28,7 +28,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_FramesDrawn method retrieves the number of frames actually drawn since streaming started. Pointer to the number of frames drawn since streaming started. @@ -36,7 +36,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_FramesDroppedInRenderer method retrieves the number of frames dropped by the renderer. Pointer to the number of frames dropped by the renderer. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Jitter method gets the jitter (variation in time) between successive frames delivered to the video renderer. Receives the standard deviation of the interframe time, in milliseconds. @@ -52,7 +52,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IQualProp interface provides methods for retrieving performance information from video renderers. The values returned through the interface are reset each time the filter is stopped. The Video Renderer filter and the Full Screen Renderer filter expose this interface. Applications can use this interface to retrieve video performance information. diff --git a/sources/Interop/Windows/Windows/um/amvideo/MPEG1VIDEOINFO.xml b/sources/Interop/Windows/Windows/um/amvideo/MPEG1VIDEOINFO.xml index cc89a47b48..0a1dfcf678 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/MPEG1VIDEOINFO.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/MPEG1VIDEOINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The MPEG1VIDEOINFO structure describes an MPEG-1 video stream. diff --git a/sources/Interop/Windows/Windows/um/amvideo/TRUECOLORINFO.xml b/sources/Interop/Windows/Windows/um/amvideo/TRUECOLORINFO.xml index d998eb38ca..2eb46ed7de 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/TRUECOLORINFO.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/TRUECOLORINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The TRUECOLORINFO structure contains color palette and bitmask information for a video image. diff --git a/sources/Interop/Windows/Windows/um/amvideo/VIDEOINFO.xml b/sources/Interop/Windows/Windows/um/amvideo/VIDEOINFO.xml index b6de7f408b..538c99eb77 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/VIDEOINFO.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/VIDEOINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VIDEOINFO structure is equivalent to a VIDEOINFOHEADER structure, but it contains enough memory to hold three color masks plus a color table with 256 colors. If you are writing a video filter, you can use this structure to guarantee that the format block always has enough memory to contain the largest possible VIDEOINFOHEADER structure. diff --git a/sources/Interop/Windows/Windows/um/amvideo/VIDEOINFOHEADER.xml b/sources/Interop/Windows/Windows/um/amvideo/VIDEOINFOHEADER.xml index dcc9061ad3..70951734b4 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/VIDEOINFOHEADER.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/VIDEOINFOHEADER.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VIDEOINFOHEADER structure describes the bitmap and color information for a video image. diff --git a/sources/Interop/Windows/Windows/um/amvideo/Windows.xml b/sources/Interop/Windows/Windows/um/amvideo/Windows.xml index 06a94b43ed..25d898af8c 100644 --- a/sources/Interop/Windows/Windows/um/amvideo/Windows.xml +++ b/sources/Interop/Windows/Windows/um/amvideo/Windows.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The BITMASKS macro retrieves the color masks from a VIDEOINFO structure. Pointer to a VIDEOINFO structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The BIT_MASKS_MATCH macro compares the color masks for two VIDEOINFO structures. Pointer to the first VIDEOINFO structure. @@ -19,49 +19,49 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The COLORS macro retrieves the palette entries from a VIDEOINFO structure. Pointer to a VIDEOINFO structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DIBSIZE macro calculates the number of bytes required by a device-independent bitmap (DIB). Specifies a structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The HEADER macro returns the address of the within a VIDEOINFOHEADER. Pointer to a VIDEOINFOHEADER structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The MPEG1_SEQUENCE_INFO macro returns the address of the sequence header inside an MPEG1VIDEOINFO structure. Pointer to an MPEG1VIDEOINFO structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PALETTE_ENTRIES macro retrieves the maximum number of colors in the palette of a specified bitmap. Pointer to a VIDEOINFOHEADER structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PALETTISED macro checks whether a bitmap has a color depth of 8 bits or less. Pointer to a VIDEOINFOHEADER structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RESET_HEADER macro fills a VIDEOINFOHEADER with zeroes. You can also use this macro to clear just the VIDEOINFOHEADER portion of a VIDEOINFO structure. This macro is equivalent to calling ZeroMemory with sizeof(VIDEOINFOHEADER). @@ -69,21 +69,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RESET_MASKS macro fills the color mask fields in a VIDEOINFO structure with zeroes. Pointer to a VIDEOINFO structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RESET_PALETTE macro fills the palette entries in a VIDEOINFO structure with zeroes. Pointer to a VIDEOINFO structure. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SIZE_MPEG1VIDEOINFO macro calculates the size of an MPEG1VIDEOINFO structure, including the sequence header (bSequenceHeader). Pointer to an MPEG1VIDEOINFO structure. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVAudioChannelConfig.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVAudioChannelConfig.xml index 2a135423b0..f77b911a37 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVAudioChannelConfig.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVAudioChannelConfig.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the speaker configuration for the audio channels in the audio bit stream. This enumeration is used with the AVAudioChannelConfig property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDDSurroundMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDDSurroundMode.xml index 06d1ea9f2a..5492c22e96 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDDSurroundMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDDSurroundMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the audio is encoded in Dolby Surround. This enumeration is used with the AVDDSurroundMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDSPLoudnessEqualization.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDSPLoudnessEqualization.xml index 74d5623735..da9b1cf647 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDSPLoudnessEqualization.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDSPLoudnessEqualization.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether loudness equalization is enabled in an audio decoder or digital signal processor (DSP). This enumeration is used with the AVDSPLoudnessEqualization property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDSPSpeakerFill.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDSPSpeakerFill.xml index 36c2b9144d..c4dc29672f 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDSPSpeakerFill.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDSPSpeakerFill.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether speaker fill is enabled in an audio decoder or digital signal processor (DSP). This enumeration is used with the AVDSPSpeakerFill property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDecAACDownmixMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDecAACDownmixMode.xml index 17e7a390a1..fea81f22e3 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDecAACDownmixMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDecAACDownmixMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether an AAC decoder uses standard MPEG-2/MPEG-4 stereo downmix equations. This enumeration is used with the AVDecAACDownmixMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDecAudioDualMono.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDecAudioDualMono.xml index 0546883400..a1476e8af8 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDecAudioDualMono.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDecAudioDualMono.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the input audio stream is stereo or dual mono. This enumeration is used with the AVDecAudioDualMono property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDecAudioDualMonoReproMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDecAudioDualMonoReproMode.xml index 9b74a94c16..c40abba115 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDecAudioDualMonoReproMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDecAudioDualMonoReproMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies how the decoder reproduces dual mono audio. This enumeration is used with the AVDecAudioDualMonoReproMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDecDDOperationalMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDecDDOperationalMode.xml index a1ce8dfa9c..31a2b6c344 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDecDDOperationalMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDecDDOperationalMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the compression control mode for a Dolby AC-3 or Dolby Enhanced AC-3 audio stream. This enumeration is used with the AVDecDDOperationalMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDecHEAACDynamicRangeControl.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDecHEAACDynamicRangeControl.xml index 4cd6703a8c..90317c0a5c 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDecHEAACDynamicRangeControl.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDecHEAACDynamicRangeControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether an AAC decoder performs dynamic range control. This enumeration is used with the AVDecHEAACDynamicRangeControl property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoInputScanType.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoInputScanType.xml index ab7ba20470..d546601eef 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoInputScanType.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoInputScanType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies how the decoded video stream is interlaced. This enumeration is used with the AVDecVideoInputScanType property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoSWPowerLevel.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoSWPowerLevel.xml index cfb64f301a..8e9b69f93e 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoSWPowerLevel.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoSWPowerLevel.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the power-saving level of a video decoder. This enumeration is used with the AVDecVideoSWPowerLevel property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoSoftwareDeinterlaceMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoSoftwareDeinterlaceMode.xml index ece0990ab2..c9be7b7ca4 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoSoftwareDeinterlaceMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVDecVideoSoftwareDeinterlaceMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies a video decoder's software deinterlace mode. This enumeration is used with the AVDecVideoSoftwareDeinterlaceMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncAudioDualMono.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncAudioDualMono.xml index ce02d16b49..697b4f6f90 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncAudioDualMono.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncAudioDualMono.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether 2-channel audio is encoded as stereo or dual mono. This enumeration is used with the AVEncAudioDualMono property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncAudioInputContent.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncAudioInputContent.xml index fb217cd399..499d78271b 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncAudioInputContent.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncAudioInputContent.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the audio content contains music or voice. This enumeration is used with the AVEncAudioInputContent property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncCommonRateControlMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncCommonRateControlMode.xml index eca85c57be..fdaed91ac2 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncCommonRateControlMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncCommonRateControlMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the rate control mode for an encoder. This enumeration is used with the AVEncCommonRateControlMode codec property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncCommonStreamEndHandling.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncCommonStreamEndHandling.xml index a81a425dd7..532469fbcb 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncCommonStreamEndHandling.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncCommonStreamEndHandling.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the encoder discards partial groups of pictures (GOPs) at the end of the stream. This enumeration is used with the AVEncCommonStreamEndHandling codec property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDAtoDConverterType.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDAtoDConverterType.xml index e9a4d4d69f..9c09af0aa4 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDAtoDConverterType.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDAtoDConverterType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the type of analog-to-digital (A/D) conversion for a Dolby Digital audio stream. This enumeration is used with the AVEncDDAtoDConverterType property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDDynamicRangeCompressionControl.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDDynamicRangeCompressionControl.xml index 8f13ce8485..6db999856e 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDDynamicRangeCompressionControl.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDDynamicRangeCompressionControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the dynamic range control profile in a Dolby Digital audio stream. This enumeration is used with the AVEncDDDynamicRangeCompressionControl property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDHeadphoneMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDHeadphoneMode.xml index a6f0d7a59d..6419b10437 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDHeadphoneMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDHeadphoneMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies headphone mode for a Dolby Digital audio stream. This enumeration is used with the AVEncDDHeadphoneMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDPreferredStereoDownMixMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDPreferredStereoDownMixMode.xml index 1408f38df9..afd95973b6 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDPreferredStereoDownMixMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDPreferredStereoDownMixMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the preferred stereo downmix mode for a Dolby Digital audio stream. This enumeration is used with the AVEncDDPreferredStereoDownMixMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDProductionRoomType.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDProductionRoomType.xml index be39a741d8..6cd6cec8f2 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDProductionRoomType.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDProductionRoomType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the room type for a Dolby Digital audio stream. This enumeration is used with the AVEncDDProductionRoomType property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDService.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDService.xml index 37cbd2ac87..7ea71d0706 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDService.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDService.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the audio service contained in a Dolby Digital audio stream. This enumeration is used with the AVEncDDService property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDSurroundExMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDSurroundExMode.xml index 2923146bd8..ce7cc6f90d 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDSurroundExMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncDDSurroundExMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether a Dolby Digital audio stream is encoded in Dolby Digital Surround EX. This enumeration is used with the AVEncDDSurroundExMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncInputVideoSystem.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncInputVideoSystem.xml index 2f348d8e29..b65b746041 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncInputVideoSystem.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncInputVideoSystem.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the nominal range for a video source. This enumeration is used with the AVEncInputVideoSystem property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPACodingMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPACodingMode.xml index 71a4ca8854..50393ec25a 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPACodingMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPACodingMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the MPEG audio encoding mode. This enumeration is used with the AVEncMPACodingMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPAEmphasisType.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPAEmphasisType.xml index fa92e0805e..f3fb4103af 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPAEmphasisType.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPAEmphasisType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the type of de-emphasis filter that should be used when decoding. This enumeration is used with the AVEncMPAEmphasisType property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPALayer.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPALayer.xml index ae296a856c..bd3bc10ec1 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPALayer.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPALayer.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the MPEG audio layer. This enumeration is used with the AVEncMPALayer property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVFrameFieldMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVFrameFieldMode.xml index ea6dffdbc1..9b332f1d60 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVFrameFieldMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVFrameFieldMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the encoder produces encoded fields or encoded frames. This enumeration is used with the AVEncMPVFrameFieldMode property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVIntraVLCTable.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVIntraVLCTable.xml index ec3c02eaba..ae1978a8ce 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVIntraVLCTable.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVIntraVLCTable.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies which variable-length coding (VLC) table to use for entropy coding. This enumeration is used with the AVEncMPVIntraVLCTable property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVLevel.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVLevel.xml index a55f74fdf0..aa1a20e44a 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVLevel.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVLevel.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the MPEG-2 profile. This enumeration is used with the AVEncMPVLevel property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVProfile.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVProfile.xml index 788a894f6b..9fb8537f26 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVProfile.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVProfile.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the MPEG-2 profile. This enumeration is used with the AVEncMPVProfile property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVQScaleType.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVQScaleType.xml index 34c30b2e6d..e62221f0e7 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVQScaleType.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVQScaleType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the quantizer scale is linear or non-linear. This enumeration is used with the AVEncMPVQScaleType property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVScanPattern.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVScanPattern.xml index 9fb4d280df..14e49b4e86 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVScanPattern.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVScanPattern.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the macroblock scan pattern. This enumeration is used with the AVEncMPVScanPattern property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVSceneDetection.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVSceneDetection.xml index c5247d528b..7a52781b1c 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVSceneDetection.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMPVSceneDetection.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies how the encoder behaves when it detects a new scene. This enumeration is used with the AVEncMPVSceneDetection property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMuxOutput.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMuxOutput.xml index 8c478096e4..17ac4ea64c 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncMuxOutput.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncMuxOutput.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the type of output stream produced by a multiplexer. This enumeration is used with the AVEncMuxOutputStreamType property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoChromaResolution.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoChromaResolution.xml index da10fd336a..805606c1b9 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoChromaResolution.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoChromaResolution.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies chroma resolution. This enumeration is used with the AVEncVideoInputChromaResolution and AVEncVideoOutputChromaResolution properties. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoChromaSubsampling.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoChromaSubsampling.xml index 8026d425b6..3db5465414 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoChromaSubsampling.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoChromaSubsampling.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies chroma siting. Chroma siting defines the positions of the chroma samples relative to the luma samples. This enumeration is used with the AVEncVideoInputChromaSubsampling and AVEncVideoOutputChromaSubsampling properties. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorLighting.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorLighting.xml index 58a836f51c..a6cf1cf5bc 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorLighting.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorLighting.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the intended lighting conditions for viewing a video source. This enumeration is used with the AVEncVideoInputColorLighting and AVEncVideoOutputColorLighting properties. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorNominalRange.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorNominalRange.xml index d5987693c6..9d03d55546 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorNominalRange.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorNominalRange.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the nominal range for a video source. This enumeration is used with the AVEncVideoInputChromaSubsampling and AVEncVideoOutputChromaSubsampling properties. The nominal range describes how luma components normalized to a range of [0..1] map to 8-bit or 10-bit samples. The mapping determines whether the color data includes headroom and toeroom. Headroom allows for values beyond 1.0 white ("whiter than white"), and toeroom allows for values below reference 0.0 black ("blacker than black"). diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorPrimaries.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorPrimaries.xml index 82f56af665..ab870a2187 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorPrimaries.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorPrimaries.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the color primaries of the video. This enumeration is used with the AVEncVideoInputColorPrimaries and AVEncVideoOutputColorPrimaries properties. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorTransferFunction.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorTransferFunction.xml index 28f1fc3679..29a4d2f6d4 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorTransferFunction.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorTransferFunction.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the conversion function from R'G'B' to RGB. This enumeration is used with the AVEncVideoInputColorTransferFunction and AVEncVideoOutputColorTransferFunction properties. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorTransferMatrix.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorTransferMatrix.xml index 26501effa2..188a89ff29 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorTransferMatrix.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoColorTransferMatrix.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the conversion matrix from the Y'Cb'Cr' color space to the R'G'B' color space. This enumeration is used with the AVEncVideoInputColorTransferMatrix and AVEncVideoOutputColorTransferMatrix properties. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoFilmContent.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoFilmContent.xml index b401dd4cae..8535698368 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoFilmContent.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoFilmContent.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the original source of the input video was film or video. This enumeration is used with the AVEncVideoSourceFilmContent property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoOutputFrameRateConversion.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoOutputFrameRateConversion.xml index 4c4cd0ab4f..7d4853217b 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoOutputFrameRateConversion.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoOutputFrameRateConversion.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the encoder converts the frame rate, if the output frame rate does not match the input frame rate. This enumeration is used with the AVEncVideoOutputFrameRateConversion property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoOutputScanType.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoOutputScanType.xml index 2b12f8e5ac..6ec0cff909 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoOutputScanType.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoOutputScanType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies how the encoder interlaces the output video. This enumeration is used with the AVEncVideoOutputScanType property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoSourceScanType.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoSourceScanType.xml index 3e82c9e23d..2131bcb22b 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoSourceScanType.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVEncVideoSourceScanType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether the input frames for an encoder are progressive or interlaced. This enumeration is used with the AVEncVideoForceSourceScanType property. diff --git a/sources/Interop/Windows/Windows/um/codecapi/eAVFastDecodeMode.xml b/sources/Interop/Windows/Windows/um/codecapi/eAVFastDecodeMode.xml index 2fc56f9462..0a33e5c0a5 100644 --- a/sources/Interop/Windows/Windows/um/codecapi/eAVFastDecodeMode.xml +++ b/sources/Interop/Windows/Windows/um/codecapi/eAVFastDecodeMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the video decoding speed. This enumeration is used with the AVDecVideoFastDecodeMode property. diff --git a/sources/Interop/Windows/Windows/um/control/IAMStats.xml b/sources/Interop/Windows/Windows/um/control/IAMStats.xml index 26b5556ab7..43d720318e 100644 --- a/sources/Interop/Windows/Windows/um/control/IAMStats.xml +++ b/sources/Interop/Windows/Windows/um/control/IAMStats.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AddValue method records a new value. Specifies the index of the statistic. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetIndex method retrieves the index for a named statistic, or creates a new statistic. Specifies the name of the statistic. @@ -100,7 +100,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetValueByIndex method retrieves a statistic, by index. Zero-based index of the statistic. @@ -172,7 +172,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetValueByName method retrieves a statistic, by name. Specifies the name of the statistic. @@ -232,7 +232,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Count method retrieves the number of statistics. Receives the number of statistics. @@ -273,14 +273,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reset method resets all statistics to zero. Returns S_OK if successful, or an HRESULT error code. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMStats interface retrieves performance data from the Filter Graph Manager. Filters can use this interface to record performance data. Filter developers: As with all Filter Graph Manager interfaces, a filter must not hold a reference count on this interface, or it will cause a circular reference count. For more information, see . diff --git a/sources/Interop/Windows/Windows/um/control/IBasicAudio.xml b/sources/Interop/Windows/Windows/um/control/IBasicAudio.xml index 8ceede65f3..b698187fd1 100644 --- a/sources/Interop/Windows/Windows/um/control/IBasicAudio.xml +++ b/sources/Interop/Windows/Windows/um/control/IBasicAudio.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Balance method retrieves the balance for the audio signal. Pointer to a variable that receives the balance. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Volume method retrieves the volume (amplitude) of the audio signal. Pointer to a variable that receive the volume. Divide by 100 to get equivalent decibel value. For example, –10,000 is –100 dB. @@ -110,7 +110,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Balance method sets the balance of the audio signal. Specifies the balance. The value can range from -10,000 to 10,000. The value -10,000 means the right channel is attenuated by 100 dB and is effectively silent. The value 10,000 means the left channel is silent. The neutral value is 0, which means that both channels are at full volume. When one channel is attenuated, the other remains at full volume. @@ -174,7 +174,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Volume method sets the volume (amplitude) of the audio signal. Specifies the volume, as a number from –10,000 to 0, inclusive. Full volume is 0, and –10,000 is silence. Multiply the desired decibel level by 100. For example, –10,000 = –100 dB. @@ -238,7 +238,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IBasicAudio interface controls the volume and balance of the audio stream. This interface is implemented on the Audio Renderer (WaveOut) filter and the DirectSound Renderer filter, but is exposed to applications through the Filter Graph Manager. Applications should always retrieve this interface from the Filter Graph Manager. diff --git a/sources/Interop/Windows/Windows/um/control/IBasicVideo.xml b/sources/Interop/Windows/Windows/um/control/IBasicVideo.xml index 96b7bec1b9..350c21d72d 100644 --- a/sources/Interop/Windows/Windows/um/control/IBasicVideo.xml +++ b/sources/Interop/Windows/Windows/um/control/IBasicVideo.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentImage method retrieves the current image waiting at the renderer. Pointer to a variable that contains the size of the buffer that the caller is passing in. If pDIBImage is NULL, this parameter receives the required buffer size. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDestinationPosition method retrieves the position of the destination rectangle. Pointer to a variable that receives the x-coordinate, in pixels. @@ -24,7 +24,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSourcePosition method retrieves the position of the source rectangle. Pointer to a variable that receives the x-coordinate, in pixels. @@ -35,7 +35,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetVideoPaletteEntries method retrieves the palette colors for the video. Start index for the palette. @@ -103,7 +103,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetVideoSize method retrieves the native video dimensions. Pointer to a variable that receives the width of the video image, in pixels. @@ -112,7 +112,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_AvgTimePerFrame method retrieves the average time between successive frames. Pointer to a variable of type REFTIME that receives the average frame time, in seconds. @@ -120,7 +120,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_BitErrorRate method retrieves the approximate bit error rate of the video stream Pointer to a variable that receives the approximate number of bits per error. @@ -128,7 +128,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_BitRate method retrieves the approximate bit rate of the video stream. Pointer to a variable that receives the approximate bit rate, in bits per second. @@ -136,7 +136,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_DestinationHeight method retrieves the height of the destination rectangle. Pointer to a variable that receives the height, in pixels. @@ -144,7 +144,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_DestinationLeft method retrieves the x-coordinate of the destination rectangle. Pointer to a variable that receives the x-coordinate, in pixels. @@ -152,7 +152,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_DestinationTop method retrieves the y-coordinate of the destination rectangle. Pointer to a variable that receives the y-coordinate, in pixels. @@ -160,7 +160,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_DestinationWidth method retrieves the width of the destination rectangle. Pointer to a variable that receives the width, in pixels. @@ -168,7 +168,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_SourceHeight method retrieves the height of the source rectangle. Pointer to a variable that receives the current height, in pixels. @@ -176,7 +176,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_SourceLeft method retrieves the x-coordinate of the source rectangle. Pointer to a variable that receives the x-coordinate, in pixels. @@ -184,7 +184,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_SourceTop method retrieves the y-coordinate of the source rectangle. Pointer a variable that receives the y-coordinate, in pixels. @@ -192,7 +192,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_SourceWidth method retrieves the width of the source rectangle. Pointer to a variable that receives the width, in pixels. @@ -200,7 +200,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_VideoHeight method retrieves the native height of the video. Pointer to a variable that receives the height, in pixels. @@ -208,7 +208,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_VideoWidth method retrieves the native width of the video. Pointer to a variable that receives the width of the video, in pixels. @@ -216,21 +216,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsUsingDefaultDestination method queries whether the renderer is using the default destination rectangle. Returns S_OK if the renderer is using the default destination rectangle, or S_FALSE otherwise. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsUsingDefaultSource method queries whether the renderer is using the default source rectangle. Returns S_OK if the renderer is using the default source rectangle, or S_FALSE otherwise. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_DestinationHeight method sets the height of the destination rectangle. Specifies the height, in pixels. @@ -282,7 +282,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_DestinationLeft method sets the x-coordinate of the destination rectangle. Specifies the x-coordinate, in pixels. @@ -290,7 +290,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_DestinationTop method sets the y-coordinate of the destination rectangle. Specifies the y-coordinate, in pixels. @@ -298,7 +298,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_DestinationWidth method sets the width of the destination rectangle. Specifies the width, in pixels. @@ -350,7 +350,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_SourceHeight method sets the height of the source rectangle. Specifies the height, in pixels. @@ -358,7 +358,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_SourceLeft method sets the x-coordinate of the source rectangle. Specifies the x-coordinate, in pixels. @@ -410,7 +410,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_SourceTop method sets the y-coordinate of the source rectangle. Specifies the y-coordinate, in pixels. @@ -462,7 +462,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_SourceWidth method sets the width of the source rectangle. Specifies the width, in pixels. @@ -470,21 +470,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDefaultDestinationPosition method reverts to the default destination rectangle. After this method is called, the video renderer uses the entire window for playback. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDefaultSourcePosition method reverts to the default source rectangle. After this method is called, the video renderer uses the entire video image, without cropping. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDestinationPosition method sets the destination rectangle. Specifies the x-coordinate, in pixels. @@ -539,7 +539,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetSourcePosition method sets the source rectangle. Specifies the x-coordinate, in pixels. @@ -550,7 +550,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IBasicVideo interface sets video properties such as the destination and source rectangles. The Video Renderer filter and Video Mixing Renderer filters implement this interface, but the interface is exposed to applications through the Filter Graph Manager. Applications should always retrieve this interface from the Filter Graph Manager. The IBasicVideo interface manipulates the following rectangles associated with the video image: diff --git a/sources/Interop/Windows/Windows/um/control/IBasicVideo2.xml b/sources/Interop/Windows/Windows/um/control/IBasicVideo2.xml index 067fe99255..08e33134d1 100644 --- a/sources/Interop/Windows/Windows/um/control/IBasicVideo2.xml +++ b/sources/Interop/Windows/Windows/um/control/IBasicVideo2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetPreferredAspectRatio method retrieves the preferred aspect ratio. Pointer to a value that indicates the x-axis aspect ratio. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IBasicVideo2 interface extends the interface. The Video Renderer filter and Video Mixing Renderer filters implement this interface, but the interface is exposed to applications through the Filter Graph Manager. Applications should always retrieve this interface from the Filter Graph Manager. diff --git a/sources/Interop/Windows/Windows/um/control/IDeferredCommand.xml b/sources/Interop/Windows/Windows/um/control/IDeferredCommand.xml index 8199727243..bafedf203b 100644 --- a/sources/Interop/Windows/Windows/um/control/IDeferredCommand.xml +++ b/sources/Interop/Windows/Windows/um/control/IDeferredCommand.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Cancel method cancels a command that the application previously queued. @@ -43,7 +43,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Confidence method retrieves a confidence value that indicates how likely it is for the command to be invoked at the requested time. This method is not implemented and returns E_NOTIMPL. @@ -52,7 +52,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetHResult method retrieves the return value from the invoked command. Receives the HRESULT value. @@ -105,7 +105,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Postpone method specifies a new invocation time for the command. New time at which to invoke the command. @@ -145,7 +145,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDeferredCommand interface cancels or modify graph-control commands that were queued using the interface. When an application calls an IQueueCommand method on the Filter Graph Manager, it receives a pointer to the IDeferredCommand interface. The application can use the interface to cancel or postpone the command, or retrieve the return value from the command. diff --git a/sources/Interop/Windows/Windows/um/control/IMediaControl.xml b/sources/Interop/Windows/Windows/um/control/IMediaControl.xml index 57e1c275e3..1ed1e9bdc8 100644 --- a/sources/Interop/Windows/Windows/um/control/IMediaControl.xml +++ b/sources/Interop/Windows/Windows/um/control/IMediaControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AddSourceFilter method adds a source filter to the filter graph. This method is intended for use by Visual Basic 6.0 applications. It was documented for Visual Basic 6.0 as the FilgraphManager.AddSourceFilter method. C++ applications should use the method instead. @@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetState method retrieves the state of the filter graph—paused, running, or stopped. State transitions are not necessarily synchronous. Therefore, when you call this method, the filter graph might be in transition to a new state. In that case, the method blocks until the transition completes or until the specified time-out elapses. @@ -80,7 +80,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_FilterCollection method retrieves a collection of the filters in the filter graph. This method is intended for use by Visual Basic 6.0 applications. It was documented for Visual Basic 6.0 as the FilgraphManager.FilterCollection property. C++ applications should use the method instead. @@ -89,7 +89,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_RegFilterCollection method retrieves a collection of all the filters listed in the registry. This method is intended for use by Visual Basic 6.0 applications. It was documented for Visual Basic 6.0 as the FilgraphManager.RegFilterCollection property. C++ applications should use the method instead. @@ -98,7 +98,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Pause method pauses all the filters in the filter graph. @@ -137,7 +137,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RenderFile method builds a filter graph that renders the specified file. This method is intended for use by Visual Basic 6.0 applications. It was documented for Visual Basic 6.0 as the FilgraphManager.RenderFile method. C++ applications should use the method instead. @@ -146,7 +146,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Run method runs all the filters in the filter graph. While the graph is running, data moves through the graph and is rendered. @@ -185,14 +185,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Stop method stops all the filters in the graph. Returns S_OK if successful, or an HRESULT value that indicates the cause of the error. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StopWhenReady method pauses the filter graph, allowing filters to queue data, and then stops the filter graph. @@ -231,7 +231,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaControl interface provides methods for controlling the flow of data through the filter graph. It includes methods for running, pausing, and stopping the graph. The Filter Graph Manager implements this interface. For more information on filter graph states, see Data Flow in the Filter Graph. diff --git a/sources/Interop/Windows/Windows/um/control/IMediaEvent.xml b/sources/Interop/Windows/Windows/um/control/IMediaEvent.xml index 4efeb02bc7..80cc8a3769 100644 --- a/sources/Interop/Windows/Windows/um/control/IMediaEvent.xml +++ b/sources/Interop/Windows/Windows/um/control/IMediaEvent.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CancelDefaultHandling method cancels the Filter Graph Manager's default handling for a specified event. The event notification is passed to the application. Event code for which to cancel default handling. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FreeEventParams method frees resources associated with the parameters of an event. Event code. @@ -54,7 +54,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetEvent method retrieves the next event notification from the event queue. Pointer to a variable that receives the event code. @@ -97,7 +97,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetEventHandle method retrieves a handle to a manual-reset event that remains signaled while the queue contains event notifications. Pointer to a variable that receives the event handle. @@ -105,7 +105,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RestoreDefaultHandling method restores the Filter Graph Manager's default handling for a specified event. Event code for which to restore default handling. @@ -145,7 +145,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The WaitForCompletion method waits for the filter graph to render all available data. The filter graph must be running or the method fails. Time-out interval, in milliseconds. Pass zero to return immediately. Pass the value INFINITE to block indefinitely. @@ -198,7 +198,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaEvent interface contains methods for retrieving event notifications and for overriding the Filter Graph Manager's default handling of events. The interface inherits this interface and extends it. The Filter Graph Manager implements this interface. Applications can use it to respond to events that occur in the filter graph, such as the end of a stream or a rendering error. Filters post events to the filter graph using the interface. For more information about event notification, see Event Notification in DirectShow. For a list of system-defined event notifications, see Event Notification Codes. diff --git a/sources/Interop/Windows/Windows/um/control/IMediaEventEx.xml b/sources/Interop/Windows/Windows/um/control/IMediaEventEx.xml index 26dfffa3b8..a8f70e18cf 100644 --- a/sources/Interop/Windows/Windows/um/control/IMediaEventEx.xml +++ b/sources/Interop/Windows/Windows/um/control/IMediaEventEx.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FreeEventParams method frees resources associated with the parameters of an event. Event code. @@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetEvent method retrieves the next event notification from the event queue. Pointer to a variable that receives the event code. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNotifyFlags method determines whether event notifications are enabled. @@ -81,7 +81,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetNotifyFlags method enables or disables event notifications. @@ -105,7 +105,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetNotifyWindow method registers a window to process event notifications. Handle to the window, or NULL to stop receiving event messages. @@ -115,7 +115,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaEventEx interface inherits the interface, which contains methods for retrieving event notifications and for overriding the filter graph's default handling of events. IMediaEventEx adds methods that enable an application window to receive messages when events occur. The Filter Graph Manager implements this interface. For more information about event notification, see Event Notification in DirectShow. For a list of system-defined event notifications, see Event Notification Codes. diff --git a/sources/Interop/Windows/Windows/um/control/IMediaPosition.xml b/sources/Interop/Windows/Windows/um/control/IMediaPosition.xml index ae59cdea17..0fb5d5abe9 100644 --- a/sources/Interop/Windows/Windows/um/control/IMediaPosition.xml +++ b/sources/Interop/Windows/Windows/um/control/IMediaPosition.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CanSeekBackward method determines whether the filter graph can seek backward in the stream. Pointer to a variable that receives the value OATRUE if the graph can seek backward, or OAFALSE otherwise. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CanSeekForward method determines whether the filter graph can seek forward in the stream. Pointer to a variable that receives the value OATRUE if the graph can seek forward, or OAFALSE otherwise. @@ -110,7 +110,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_CurrentPosition method retrieves the current position, relative to the total duration of the stream. Pointer to a variable that receives the current position, in seconds. @@ -163,7 +163,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Duration method retrieves the duration of the stream. Pointer to a variable that receives the total stream length, in seconds. @@ -216,7 +216,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_PrerollTime method retrieves the amount of data that will be queued before the start position. Pointer to a variable that receives the preroll time, in seconds. @@ -269,7 +269,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Rate method retrieves the playback rate. Pointer to a variable that receives the playback rate. @@ -322,7 +322,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_StopTime method retrieves the time at which the playback will stop, relative to the duration of the stream. Pointer to a variable that receives the stop time, in seconds. @@ -375,7 +375,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_CurrentPosition method sets the current position, relative to the total duration of the stream. New position, in seconds. @@ -439,7 +439,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_PrerollTime method sets the amount of data that will be queued before the start position. Preroll time, in seconds. @@ -479,7 +479,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Rate method sets the playback rate. Playback rate. Must not be zero. @@ -531,7 +531,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_StopTime method sets the time at which the playback will stop, relative to the duration of the stream. Stop time, in seconds. @@ -583,7 +583,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaPosition interface contains methods for seeking to a position within a stream.
Note  Applications should use instead of IMediaPosition.
diff --git a/sources/Interop/Windows/Windows/um/control/IQueueCommand.xml b/sources/Interop/Windows/Windows/um/control/IQueueCommand.xml index c3ba7d451a..fc874f309c 100644 --- a/sources/Interop/Windows/Windows/um/control/IQueueCommand.xml +++ b/sources/Interop/Windows/Windows/um/control/IQueueCommand.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The InvokeAtPresentationTime method queues a method to be invoked at the specified presentation time. Address of a variable that receives an interface pointer. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The InvokeAtStreamTime method queues a method or property change for execution at a specified stream time (that is, presentation time relative to the current stream time offset). Address of a variable that receives an interface pointer. @@ -36,7 +36,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IQueueCommand interface queues a command for processing at a designated time. The Filter Graph Manager exposes this interface. Applications can use it to queue graph-control commands in advance. The methods in IQueueCommand are modeled after the IDispatch.InvokeAt method. The application specifies an interface, a method on the interface, parameters to the method, and a reference time. The Filter Graph Manager queues this information and then invokes the method at the specified time. The requested interface must inherit IDispatch and must be exposed by the Filter Graph Manager. Examples include , , and . When the command is queued, the filter graph manager returns a pointer to the interface. The application can use this interface to cancel or modify the command. diff --git a/sources/Interop/Windows/Windows/um/control/IVideoWindow.xml b/sources/Interop/Windows/Windows/um/control/IVideoWindow.xml index 336c4fbd9c..ab7a5493e4 100644 --- a/sources/Interop/Windows/Windows/um/control/IVideoWindow.xml +++ b/sources/Interop/Windows/Windows/um/control/IVideoWindow.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMaxIdealImageSize method retrieves the maximum ideal image size for the video image. Receives the maximum ideal width, in pixels. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMinIdealImageSize method retrieves the minimum ideal size for the video image. Receives the minimum ideal width, in pixels. @@ -136,7 +136,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetRestorePosition method retrieves the restored window position. Receives the x-coordinate, in pixels. @@ -192,7 +192,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetWindowPosition method retrieves the position of the video window. Receives the x-coordinate, in pixels. @@ -248,7 +248,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_AutoShow method queries whether the video renderer automatically shows the video window when it receives video data. @@ -317,7 +317,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_BackgroundPalette method queries whether the video window realizes its palette in the background.. @@ -386,7 +386,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_BorderColor method retrieves the color that appears around the edges of the destination rectangle. Receives a COLORREF value. @@ -439,7 +439,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Caption method retrieves the video window caption. Pointer to a BSTR that receives the caption. @@ -492,7 +492,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_FullScreenMode method queries whether the video renderer is in full-screen mode. Receives the value OATRUE if the video renderer is in full-screen mode, or OAFALSE otherwise. @@ -557,7 +557,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Height method retrieves the height of the video window. Receives the height, in pixels. @@ -610,7 +610,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Left method retrieves the video window's x-axis coordinate. Receives the x-axis coordinate, in pixels. @@ -663,7 +663,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_MessageDrain method retrieves the window that receives mouse and keyboard messages from the video window, if any. Receives a handle to the window, as an OAHWND type. If no message drain was set, this parameter receives the value NULL. @@ -716,7 +716,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Owner method retrieves the video window's parent window, if any. Receives a handle to the window, as an OAHWND type. If the video window has no parent, this parameter receives the value NULL. @@ -769,7 +769,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Top method retrieves the video window's y-coordinate. Receives the y-coordinate, in pixels. @@ -822,7 +822,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Visible method queries whether the video window is visible. Receives the value OATRUE if the window is visible, or OAFALSE if the window is hidden. @@ -875,7 +875,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Width method retrieves the width of the video window. Receives the width, in pixels. @@ -928,7 +928,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_WindowState method queries whether the video window is visible, hidden, minimized, or maximized. @@ -996,7 +996,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_WindowStyle method retrieves the window styles on the video window. Receives the window style flags. @@ -1049,7 +1049,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_WindowStyleEx method retrieves the extended window styles on the video window. Receives the window style flags. @@ -1102,7 +1102,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The HideCursor method shows or hides the cursor when the mouse is positioned over the video window. @@ -1186,7 +1186,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsCursorHidden method queries whether the cursor is hidden. Receives the value OATRUE if the cursor is hidden, or OAFALSE if the cursor is displayed. @@ -1239,7 +1239,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NotifyOwnerMessage method forwards a message to the video window. A handle to the window, as an OAHWND value. @@ -1282,7 +1282,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_AutoShow method specifies whether the video renderer automatically shows the video window when it receives video data. @@ -1350,7 +1350,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_BackgroundPalette method specifies whether the video window realizes its palette in the background. @@ -1418,7 +1418,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_BorderColor method sets the color that appears around the edges of the destination rectangle. The border color, specified as a COLORREF value. @@ -1458,7 +1458,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Caption method sets the video window caption. A BSTR that contains the caption. @@ -1511,7 +1511,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_FullScreenMode method enables or disables full-screen video rendering. @@ -1591,7 +1591,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Height method sets the height of the video window. The height, in pixels. @@ -1643,7 +1643,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Left method sets the x-coordinate of the video window. The x-coordinate, in pixels. @@ -1695,7 +1695,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_MessageDrain method specifies a window to receive mouse and keyboard messages from the video window. A handle to the window, as an OAHWND value. @@ -1735,7 +1735,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Owner method specifies a parent window for the video window. A handle to the parent window, as an OAHWND value, or NULL to remove the existing parent. @@ -1775,7 +1775,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Top method specifies the y-coordinate of the video window. The y-coordinate, in pixels. @@ -1827,7 +1827,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Visible method shows or hides the video window. @@ -1895,7 +1895,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Width method specifies the width of the video window. The width, in pixels. @@ -1947,7 +1947,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_WindowState method shows, hides, minimizes, or maximizes the video window. Flag that specifies how the window is to be shown. The value can be any constant defined for the nCmdShow parameter of the function. @@ -1987,7 +1987,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_WindowStyle method sets the window styles on the video window. One or more flags from the GWL_STYLE value of the Windows SetWindowLong function. @@ -2027,7 +2027,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_WindowStyleEx method sets the extended window styles on the video window. One or more flags from the GWL_EXSTYLE value of the Windows SetWindowLong function. @@ -2067,7 +2067,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetWindowForeground method places the video window at the top of the Z order. @@ -2135,7 +2135,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetWindowPosition method sets the position of the video window. The x-coordinate, in pixels. @@ -2190,7 +2190,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVideoWindow interface sets properties on the video window. Applications can use it to set the window owner, the position and dimensions of the window, and other properties.
Note  The or IVMRWindowlessControl9 interface is now preferred over IVideoWindow. For more information, see Using Windowless Mode.
The Video Renderer filter and the Filter Graph Manager both expose this interface. The Filter Graph Manager forwards all method calls to the Video Renderer. It also forwards certain window messages that the Video Renderer needs to receive, such as WM_DISPLAYCHANGE. Because the video window is usually a child of an application window, the filter would not otherwise receive these messages. Therefore it relies on the Filter Graph Manager to forward them.In most cases, an application should query the Filter Graph Manager for this interface, and not call the filter directly, because of the messaging issue just described. However, if the filter graph has more than one Video Renderer, the Filter Graph Manager only communicates with one of them, selected arbitrarily. Therefore, if your application uses multiple video windows, use the IVideoWindow interface directly on the filters. In that case, you must forward window messages to each Video Renderer instance, using the method.To prevent the video window from flickering during repaints, override the default handling for the WM_ERASEBKGND message and do not erase the window. (For MFC applications, override CWnd.OnEraseBkgnd with an empty handler.)Properties set on a video renderer persist between successive connections and disconnections.Because this interface is Automation-compatible, all Boolean values are defined as OAFALSE (0) and OATRUE (–1).Error codes:If the video renderer filter is not connected to another filter, all methods return the error code VFW_E_NOT_CONNECTED. For the Filter Graph Manager's implementation, if the graph does not contain a video renderer filter, all methods return E_NOINTERFACE. Note that the Filter Graph Manager exposes the interface even when the graph does not contain a video renderer, so an application can query for the interface before it builds the graph.Filter Developers:You can use the CBaseVideoWindow class to help implement this interface. diff --git a/sources/Interop/Windows/Windows/um/ctfutb/ITfSystemLangBarItem.xml b/sources/Interop/Windows/Windows/um/ctfutb/ITfSystemLangBarItem.xml index 42fab5a973..33d4b084a9 100644 --- a/sources/Interop/Windows/Windows/um/ctfutb/ITfSystemLangBarItem.xml +++ b/sources/Interop/Windows/Windows/um/ctfutb/ITfSystemLangBarItem.xml @@ -78,6 +78,6 @@ - The ITfSystemLangBarItem interface is implemented by a system language bar menu and is used by a system language bar extension to modify the icon and/or tooltip string displayed for the menu. The extension can obtain an instance of this interface by by calling QueryInterface on the object with IID_ITfSystemLangBarItem. + The ITfSystemLangBarItem interface is implemented by a system language bar menu and is used by a system language bar extension to modify the icon and/or tooltip string displayed for the menu. The extension can obtain an instance of this interface by calling QueryInterface on the object with IID_ITfSystemLangBarItem. \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/devicetopology/IAudioChannelConfig.xml b/sources/Interop/Windows/Windows/um/devicetopology/IAudioChannelConfig.xml index a2c4a33ce1..3e39336fc5 100644 --- a/sources/Interop/Windows/Windows/um/devicetopology/IAudioChannelConfig.xml +++ b/sources/Interop/Windows/Windows/um/devicetopology/IAudioChannelConfig.xml @@ -56,14 +56,8 @@ The IAudioChannelConfig interface provides access to a hardware channel-configuration control. The client obtains a reference to the IAudioChannelConfig interface of a subunit by calling the method with parameter refiid set to REFIID IID_IAudioChannelConfig. The call to IPart.Activate succeeds only if the subunit supports the IAudioChannelConfig interface. Only a subunit object that represents a hardware channel-configuration control will support this interface. - A client of the IAudioChannelConfig interface programs a hardware channel-configuration control by writing a channel-configuration mask to the control. The mask specifies the assignment of audio channels to speakers. For more information about channel-configuration masks, see the following: - - - The discussion of the KSPROPERTY_AUDIO_CHANNEL_CONFIG property in the Windows DDK documentation. - - - The white paper titled "Audio Driver Support for Home Theater Speaker Configurations" at the Audio Device Technologies for Windows website. - - Most Windows audio adapter drivers support the Windows Driver Model (WDM) and use kernel-streaming (KS) properties to represent the hardware control parameters in subunits (referred to as KS nodes). The IAudioChannelConfig interface provides convenient access to the KSPROPERTY_AUDIO_CHANNEL_CONFIG property of a subunit that has a subtype GUID value of KSNODETYPE_3D_EFFECTS, KSNODETYPE_DAC, KSNODETYPE_VOLUME, or KSNODETYPE_PROLOGIC_DECODER. To obtain the subtype GUID of a subunit, call the method. For more information about KS properties and KS node types, see the Windows DDK documentation. + A client of the IAudioChannelConfig interface programs a hardware channel-configuration control by writing a channel-configuration mask to the control. The mask specifies the assignment of audio channels to speakers. For more information about channel-configuration masks, see KSPROPERTY_AUDIO_CHANNEL_CONFIG. + Most Windows audio adapter drivers support the Windows Driver Model (WDM) and use kernel-streaming (KS) properties to represent the hardware control parameters in subunits (referred to as KS nodes). The IAudioChannelConfig interface provides convenient access to the KSPROPERTY_AUDIO_CHANNEL_CONFIG property of a subunit that has a subtype GUID value of KSNODETYPE_3D_EFFECTS, KSNODETYPE_DAC, KSNODETYPE_VOLUME, or KSNODETYPE_PROLOGIC_DECODER. To obtain the subtype GUID of a subunit, call the method. For more information about KS properties and KS node types, see the Windows DDK documentation. + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_COLCON.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_COLCON.xml index 8a685f166f..d8a2f5d1a6 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_COLCON.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_COLCON.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the color contrast description from the DVD highlight (HLI) structure. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_COPY_MACROVISION.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_COPY_MACROVISION.xml index 7a1689e7ba..debe71d7be 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_COPY_MACROVISION.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_COPY_MACROVISION.xml @@ -6,6 +6,6 @@ The AM_COPY_MACROVISION structure specifies the analog copy protection level for an NTSC encoder. - Analog copy protection level for the NTSC encoder. Member of the enumerated data type. + Analog copy protection level for the NTSC encoder. Member of the AM_COPY_MACROVISION_LEVEL enumerated data type. \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_COPY_MACROVISION_LEVEL.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_COPY_MACROVISION_LEVEL.xml index 7281087e34..97f73a02f4 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_COPY_MACROVISION_LEVEL.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_COPY_MACROVISION_LEVEL.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Identifies the analog copy protection level. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPYSTATE.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPYSTATE.xml index f79467bf5f..2927c1b269 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPYSTATE.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPYSTATE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the copy protection state. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_BUSKEY.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_BUSKEY.xml index f4dddad1e5..583dc17ea6 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_BUSKEY.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_BUSKEY.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Identifies the DVD bus key. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_CHLGKEY.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_CHLGKEY.xml index 98c95c73e2..e1bca9e8b0 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_CHLGKEY.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_CHLGKEY.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Identifies the DVD challenge key. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_DISCKEY.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_DISCKEY.xml index c3a19bf148..f5980e95e6 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_DISCKEY.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_DISCKEY.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the DVD disc key. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_SET_COPY_STATE.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_SET_COPY_STATE.xml index 8c8a876288..dfafc23847 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_SET_COPY_STATE.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_SET_COPY_STATE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the copy protection state of the filter. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_TITLEKEY.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_TITLEKEY.xml index 2891be0f1a..e0ec416030 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_TITLEKEY.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVDCOPY_TITLEKEY.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the DVD title key from the current content. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVD_YUV.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVD_YUV.xml index cdcc7b0fa3..52ad51681c 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVD_YUV.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DVD_YUV.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Contains DVD YUV subpicture data. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DvdKaraokeData.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DvdKaraokeData.xml index 5ccb8f839c..edba95b0e7 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_DvdKaraokeData.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_DvdKaraokeData.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies how to mix the karaoke audio channels. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_ExactRateChange.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_ExactRateChange.xml index 065c78864e..808988a983 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_ExactRateChange.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_ExactRateChange.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_ExactRateChange structure is not supported. Use . diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_MPEG2Level.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_MPEG2Level.xml index 4239537089..799fc627dd 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_MPEG2Level.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_MPEG2Level.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates an MPEG-2 video level as specified in the MPEG-2 video standard (ISO13818-2). diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_MPEG2Profile.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_MPEG2Profile.xml index 3755d49960..7b93b8d2d0 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_MPEG2Profile.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_MPEG2Profile.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates an MPEG-2 video profile as specified in the MPEG-2 video standard (ISO13818-2). diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_DVD_RATE_CHANGE.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_DVD_RATE_CHANGE.xml index 361c393274..7698dce1c0 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_DVD_RATE_CHANGE.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_DVD_RATE_CHANGE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_PROPERTY_DVD_RATE_CHANGE enumeration is not used. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_SPHLI.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_SPHLI.xml index 3fd8182a00..bf47f6341b 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_SPHLI.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_SPHLI.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Describes the currently selected button from the DVD highlight information. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_SPPAL.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_SPPAL.xml index d1dc43559a..531df14098 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_SPPAL.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_PROPERTY_SPPAL.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the DVD subpicture palette. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_QueryRate.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_QueryRate.xml index f7ee89f2e2..3ad4d7d74b 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_QueryRate.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_QueryRate.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_QueryRate structure is used to query the decoder's maximum full-frame rate for forward and reverse playback. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/AM_SimpleRateChange.xml b/sources/Interop/Windows/Windows/um/dvdmedia/AM_SimpleRateChange.xml index 1252623ef2..c8c514f0f3 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/AM_SimpleRateChange.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/AM_SimpleRateChange.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_SimpleRateChange structure is used to change the playback rate for an MPEG-2 stream. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/DVD_REGION.xml b/sources/Interop/Windows/Windows/um/dvdmedia/DVD_REGION.xml index 731753f360..eefabad9b5 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/DVD_REGION.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/DVD_REGION.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Identifies the DVD region as reported by the local system components. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/MPEG2VIDEOINFO.xml b/sources/Interop/Windows/Windows/um/dvdmedia/MPEG2VIDEOINFO.xml index 1fcb1100c0..e941bf72ef 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/MPEG2VIDEOINFO.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/MPEG2VIDEOINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The MPEG2VIDEOINFO structure describes an MPEG-2 video stream. diff --git a/sources/Interop/Windows/Windows/um/dvdmedia/VIDEOINFOHEADER2.xml b/sources/Interop/Windows/Windows/um/dvdmedia/VIDEOINFOHEADER2.xml index fc887b299f..aec280aef3 100644 --- a/sources/Interop/Windows/Windows/um/dvdmedia/VIDEOINFOHEADER2.xml +++ b/sources/Interop/Windows/Windows/um/dvdmedia/VIDEOINFOHEADER2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VIDEOINFOHEADER2 structure describes the bitmap and color information for a video image, including interlace, copy protection, and pixel aspect ratio information. diff --git a/sources/Interop/Windows/Windows/um/dwmapi/DWMWINDOWATTRIBUTE.xml b/sources/Interop/Windows/Windows/um/dwmapi/DWMWINDOWATTRIBUTE.xml index 9520303142..5f18477dd7 100644 --- a/sources/Interop/Windows/Windows/um/dwmapi/DWMWINDOWATTRIBUTE.xml +++ b/sources/Interop/Windows/Windows/um/dwmapi/DWMWINDOWATTRIBUTE.xml @@ -66,11 +66,11 @@ Use with . If the window is cloaked, provides one of the following values explaining why. - DWM_CLOAKED_APP (value 0x0000001). The window was cloaked by its owner application. + DWM_CLOAKED_APP (value 0x00000001). The window was cloaked by its owner application. - DWM_CLOAKED_SHELL (value 0x0000002). The window was cloaked by the Shell. + DWM_CLOAKED_SHELL (value 0x00000002). The window was cloaked by the Shell. - DWM_CLOAKED_INHERITED (value 0x0000004). The cloak value was inherited from its owner window. + DWM_CLOAKED_INHERITED (value 0x00000004). The cloak value was inherited from its owner window. Windows 7 and earlier: This value is not supported. @@ -103,18 +103,22 @@ Use with . Specifies the color of the window border. The pvAttribute parameter points to a value of type COLORREF. The app is responsible for changing the border color according to state changes, such as a change in window activation. + Specifying DWMWA_COLOR_NONE (value 0xFFFFFFFE) for the color will suppress the drawing of the window border. This makes it possible to have a rounded window with no border. + Specifying DWMWA_COLOR_DEFAULT (value 0xFFFFFFFF) for the color will reset the window back to using the system's default behavior for the border color. This value is supported starting with Windows 11 Build 22000. Use with . Specifies the color of the caption. The pvAttribute parameter points to a value of type COLORREF. + Specifying DWMWA_COLOR_DEFAULT (value 0xFFFFFFFF) for the color will reset the window back to using the system's default behavior for the caption color. This value is supported starting with Windows 11 Build 22000. Use with . Specifies the color of the caption text. The pvAttribute parameter points to a value of type COLORREF. + Specifying DWMWA_COLOR_DEFAULT (value 0xFFFFFFFF) for the color will reset the window back to using the system's default behavior for the caption text color. This value is supported starting with Windows 11 Build 22000. diff --git a/sources/Interop/Windows/Windows/um/dwmapi/DWM_SYSTEMBACKDROP_TYPE.xml b/sources/Interop/Windows/Windows/um/dwmapi/DWM_SYSTEMBACKDROP_TYPE.xml index eef7c86bac..5fb787dd16 100644 --- a/sources/Interop/Windows/Windows/um/dwmapi/DWM_SYSTEMBACKDROP_TYPE.xml +++ b/sources/Interop/Windows/Windows/um/dwmapi/DWM_SYSTEMBACKDROP_TYPE.xml @@ -6,18 +6,30 @@ Flags for specifying the system-drawn backdrop material of a window, including behind the non-client area. - The default. Let the Desktop Window Manager (DWM) automatically decide the system-drawn backdrop material for this window. + + The default. Let the Desktop Window Manager (DWM) automatically decide the system-drawn backdrop material for this window. This applies the backdrop material just behind the default Win32 title bar. This behavior attempts to preserve maximum backwards compatibility. For this reason, the DWM might also decide to draw no backdrop material at all based on internal heuristics. + If drawing the backdrop material behind the entire window is required, choose one of the other more specific values of this enum as appropriate. + Don't draw any system backdrop. - Draw the backdrop material effect corresponding to a long-lived window. + + Draw the backdrop material effect corresponding to a long-lived window behind the entire window bounds. + For Windows 11, this corresponds to Mica in its default variant. The material effect might change with future Windows releases. For more info about Mica, see Mica. + - Draw the backdrop material effect corresponding to a transient window. + + Draw the backdrop material effect corresponding to a transient window behind the entire window bounds. + For Windows 11, this corresponds to Desktop Acrylic, also known as Background Acrylic, in its brightest variant. The material effect might change with future Windows releases. For more info about Desktop Acrylic, see Acrylic. + - Draw the backdrop material effect corresponding to a window with a tabbed title bar. + + Draw the backdrop material effect corresponding to a window with a tabbed title bar behind the entire window bounds. + For Windows 11, this corresponds to Mica in its alternate variant (Mica Alt). The material might change with future releases of Windows. For more info about Mica Alt, see Layering with Mica Alt. + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/dwmapi/Windows.xml b/sources/Interop/Windows/Windows/um/dwmapi/Windows.xml index a6abffce40..8f6a47dd0a 100644 --- a/sources/Interop/Windows/Windows/um/dwmapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/dwmapi/Windows.xml @@ -61,7 +61,7 @@ If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. - Issues a flush call that blocks the caller until the next present, when all of the Microsoft DirectX surface updates that are currently outstanding have been made. This compensates for very complex scenes or calling processes with very low priority. + Issues a flush call that blocks the caller until the next call to a Present method, when all of the Microsoft DirectX surface updates that are currently outstanding have been made. This compensates for very complex scenes or calling processes with very low priority. If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. diff --git a/sources/Interop/Windows/Windows/um/fileapi/Windows.xml b/sources/Interop/Windows/Windows/um/fileapi/Windows.xml index 5937bed622..e2763afffa 100644 --- a/sources/Interop/Windows/Windows/um/fileapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/fileapi/Windows.xml @@ -476,7 +476,7 @@ - Creates a new file, always.If the specified file exists and is writable, the function overwrites the file, the function succeeds, and last-error code is set to ERROR_ALREADY_EXISTS (183).If the specified file does not exist and is a valid path, a new file is created, the function succeeds, and the last-error code is set to zero.For more information, see the Remarks section of this topic. + Creates a new file, always.If the specified file exists and is writable, the function truncates the file, the function succeeds, and last-error code is set to ERROR_ALREADY_EXISTS (183).If the specified file does not exist and is a valid path, a new file is created, the function succeeds, and the last-error code is set to zero.For more information, see the Remarks section of this topic. @@ -672,7 +672,7 @@ - Creates a new file, always.If the specified file exists and is writable, the function overwrites the file, the function succeeds, and last-error code is set to ERROR_ALREADY_EXISTS (183).If the specified file does not exist and is a valid path, a new file is created, the function succeeds, and the last-error code is set to zero.For more information, see the Remarks section of this topic. + Creates a new file, always.If the specified file exists and is writable, the function truncates the file, the function succeeds, and last-error code is set to ERROR_ALREADY_EXISTS (183).If the specified file does not exist and is a valid path, a new file is created, the function succeeds, and the last-error code is set to zero.For more information, see the Remarks section of this topic. @@ -880,7 +880,7 @@ - Creates a new file, always.If the specified file exists and is writable, the function overwrites the file, the function succeeds, and last-error code is set to ERROR_ALREADY_EXISTS (183).If the specified file does not exist and is a valid path, a new file is created, the function succeeds, and the last-error code is set to zero.For more information, see the Remarks section of this topic. + Creates a new file, always.If the specified file exists and is writable, the function truncates the file, the function succeeds, and last-error code is set to ERROR_ALREADY_EXISTS (183).If the specified file does not exist and is a valid path, a new file is created, the function succeeds, and the last-error code is set to zero.For more information, see the Remarks section of this topic. @@ -1088,7 +1088,7 @@ - Creates a new file, always.If the specified file exists and is writable, the function overwrites the file, the function succeeds, and last-error code is set to ERROR_ALREADY_EXISTS (183).If the specified file does not exist and is a valid path, a new file is created, the function succeeds, and the last-error code is set to zero.For more information, see the Remarks section of this topic. + Creates a new file, always.If the specified file exists and is writable, the function truncates the file, the function succeeds, and last-error code is set to ERROR_ALREADY_EXISTS (183).If the specified file does not exist and is a valid path, a new file is created, the function succeeds, and the last-error code is set to zero.For more information, see the Remarks section of this topic. @@ -6837,46 +6837,46 @@ Deletes an existing empty directory. - To perform this operation as a transacted operation, use the function. + To perform this operation as a transacted operation, use the function. The path of the directory to be removed. This path must specify an empty directory, and the calling process must have delete access to the directory. - By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. -
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
+ By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. +
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
If the function succeeds, the return value is nonzero. - If the function fails, the return value is zero. To get extended error information, call. + If the function fails, the return value is zero. To get extended error information, call . Deletes an existing empty directory. - To perform this operation as a transacted operation, use the function. + To perform this operation as a transacted operation, use the function. The path of the directory to be removed. This path must specify an empty directory, and the calling process must have delete access to the directory. - By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. -
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
+ By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. +
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
If the function succeeds, the return value is nonzero. - If the function fails, the return value is zero. To get extended error information, call. + If the function fails, the return value is zero. To get extended error information, call . Deletes an existing empty directory. - To perform this operation as a transacted operation, use the function. + To perform this operation as a transacted operation, use the function. The path of the directory to be removed. This path must specify an empty directory, and the calling process must have delete access to the directory. - By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. -
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
+ By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces. +
[!TIP] Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
If the function succeeds, the return value is nonzero. - If the function fails, the return value is zero. To get extended error information, call. + If the function fails, the return value is zero. To get extended error information, call . diff --git a/sources/Interop/Windows/Windows/um/heapapi/Windows.xml b/sources/Interop/Windows/Windows/um/heapapi/Windows.xml index 0a39e507e7..61df14aeeb 100644 --- a/sources/Interop/Windows/Windows/um/heapapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/heapapi/Windows.xml @@ -394,6 +394,74 @@   The alignment of memory returned by HeapReAlloc is MEMORY_ALLOCATION_ALIGNMENT in WinNT.h:#if defined(_WIN64) || defined(_M_ALPHA) #define MEMORY_ALLOCATION_ALIGNMENT 16 #else #define MEMORY_ALLOCATION_ALIGNMENT 8 #endifIf the function fails, it does not call . An application cannot call for extended error information. + + Enables features for a specified heap. + A handle to the heap where information is to be set. This handle is returned by either the or function. + + The class of information to be set. This parameter can be one of the following values from theHEAP_INFORMATION_CLASS enumeration type. + + + Value + Meaning + + + + + + + HeapCompatibilityInformation + + + + 0 + + + + Enables heap features. Only the low-fragmentation heap (LFH) is supported. However, it is not necessary for applications to enable the LFH because the system uses the LFH as needed to service memory allocation requests. Windows XP and Windows Server 2003:  The LFH is not enabled by default. To enable the LFH for the specified heap, set the variable pointed to by the HeapInformation parameter to 2. After the LFH is enabled for a heap, it cannot be disabled.The LFH cannot be enabled for heaps created with HEAP_NO_SERIALIZE or for heaps created with a fixed size. The LFH also cannot be enabled if you are using the heap debugging tools inDebugging Tools for WindowsorMicrosoft Application Verifier.When a process is run under any debugger, certain heap debug options are automatically enabled for all heaps in the process. These heap debug options prevent the use of the LFH. To enable the low-fragmentation heap when running under a debugger, set the _NO_DEBUG_HEAP environment variable to 1. + + + + + + + HeapEnableTerminationOnCorruption + + + + 1 + + + + Enables the terminate-on-corruption feature. If the heap manager detects an error in any heap used by the process, it calls the Windows Error Reporting service and terminates the process.After a process enables this feature, it cannot be disabled.Windows Server 2003 and Windows XP:  This value is not supported until Windows Vista and Windows XP with SP3. The function succeeds but the HeapEnableTerminationOnCorruption value is ignored. + + + + + + + HeapOptimizeResources + + + + 3 + + + + If HeapSetInformation is called with HeapHandle set to NULL, then all heaps in the process with a low-fragmentation heap (LFH) will have their caches optimized, and the memory will be decommitted if possible. If a heap pointer is supplied in HeapHandle, then only that heap will be optimized.Note that the HEAP_OPTIMIZE_RESOURCES_INFORMATION structure passed in HeapInformation must be properly initialized.Note  This value was added in Windows 8.1. + + + + + The heap information buffer. The format of this data depends on the value of theHeapInformationClass parameter. + If the HeapInformationClass parameter isHeapCompatibilityInformation, the HeapInformationparameter is a pointer to a ULONG variable. + If the HeapInformationClass parameter isHeapEnableTerminationOnCorruption, the HeapInformationparameter should be NULL and HeapInformationLength should be 0 + + The size of the HeapInformation buffer, in bytes. + + If the function succeeds, the return value is nonzero. + If the function fails, the return value is 0 (zero). To get extended error information, call. + + Retrieves the size of a memory block allocated from a heap by the or function. A handle to the heap in which the memory block resides. This handle is returned by either the or function. diff --git a/sources/Interop/Windows/Windows/um/imapi2fs/IIsoImageManager.xml b/sources/Interop/Windows/Windows/um/imapi2fs/IIsoImageManager.xml index 38de080313..3a050aeef9 100644 --- a/sources/Interop/Windows/Windows/um/imapi2fs/IIsoImageManager.xml +++ b/sources/Interop/Windows/Windows/um/imapi2fs/IIsoImageManager.xml @@ -41,6 +41,13 @@ The IStream object associated with the .iso image. S_OK is returned on success, but other success codes may be returned as a result of implementation. + + Determines if the provided .iso image is valid. + + This method can return one of these values. + | Return code | Description | |-------------|-------------| | IMAPI_E_IMAGEMANAGER_IMAGE_NOT_ALIGNED | The image is not aligned on a 2kb sector boundary. | | IMAPI_E_IMAGEMANAGER_NO_VALID_VD_FOUND | The image does not contain a valid volume descriptor. | | IMAPI_E_IMAGEMANAGER_NO_IMAGE | The image has not been set using the or method prior to calling this method. | | IMAPI_E_IMAGEMANAGER_IMAGE_TOO_BIG | The provided image is too large to be validated as the size exceeds MAXLONG. | + + Use this interface to verify if an existing .iso file contains a valid file system for burning. diff --git a/sources/Interop/Windows/Windows/um/ioapiset/Windows.xml b/sources/Interop/Windows/Windows/um/ioapiset/Windows.xml index 5a5e747252..ef7eefff93 100644 --- a/sources/Interop/Windows/Windows/um/ioapiset/Windows.xml +++ b/sources/Interop/Windows/Windows/um/ioapiset/Windows.xml @@ -122,11 +122,6 @@ - - - - - A pointer to an structure that was specified when the overlapped operation was started. diff --git a/sources/Interop/Windows/Windows/um/iphlpapi/Windows.xml b/sources/Interop/Windows/Windows/um/iphlpapi/Windows.xml index e84ba903e8..3f049a303a 100644 --- a/sources/Interop/Windows/Windows/um/iphlpapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/iphlpapi/Windows.xml @@ -4813,7 +4813,7 @@ - Element not found. This error is returned on Windows Vista if the the SrcIp parameter does not specify a source IPv4 address on an interface on the local computer or the INADDR_ANY IP address (an IPv4 address of 0.0.0.0). + Element not found. This error is returned on Windows Vista if the SrcIp parameter does not specify a source IPv4 address on an interface on the local computer or the INADDR_ANY IP address (an IPv4 address of 0.0.0.0). diff --git a/sources/Interop/Windows/Windows/um/libloaderapi/Windows.xml b/sources/Interop/Windows/Windows/um/libloaderapi/Windows.xml index bff862ad8f..c174670f6d 100644 --- a/sources/Interop/Windows/Windows/um/libloaderapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/libloaderapi/Windows.xml @@ -1533,6 +1533,17 @@ The exit code for the calling thread. + + +
[!Note] This function is obsolete and is only supported for backward compatibility with 16-bit Windows. For 32-bit Windows applications, it is not necessary to free the resources loaded using . For modern versions of Windows this function always returns FALSE.
+ Decrements (decreases by one) the reference count of a loaded resource. When the reference count reaches zero, the memory occupied by the resource is freed. + + A handle of the resource. It is assumed that hglbResource was created by . + + If the function succeeds, the return value is zero. + If the function fails, the return value is nonzero, which indicates that the resource has not been freed. + + Retrieves the fully qualified path for the file that contains the specified module. The module must have been loaded by the current process. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/DMO_MEDIA_TYPE.xml b/sources/Interop/Windows/Windows/um/mediaobj/DMO_MEDIA_TYPE.xml index 44b5f52791..5253e6169e 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/DMO_MEDIA_TYPE.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/DMO_MEDIA_TYPE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_MEDIA_TYPE structure describes the format of the data used by a stream in a Microsoft DirectX Media Object (DMO). diff --git a/sources/Interop/Windows/Windows/um/mediaobj/DMO_OUTPUT_DATA_BUFFER.xml b/sources/Interop/Windows/Windows/um/mediaobj/DMO_OUTPUT_DATA_BUFFER.xml index cbe73b5113..1f63e4e611 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/DMO_OUTPUT_DATA_BUFFER.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/DMO_OUTPUT_DATA_BUFFER.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_OUTPUT_DATA_BUFFER structure describes an output buffer used by a Microsoft DirectX Media Object (DMO). diff --git a/sources/Interop/Windows/Windows/um/mediaobj/IDMOQualityControl.xml b/sources/Interop/Windows/Windows/um/mediaobj/IDMOQualityControl.xml index a67e55796f..13bf398786 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/IDMOQualityControl.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/IDMOQualityControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetStatus method determines whether quality control is active. Pointer to a variable that receives the quality control status. If quality control is disabled, the value is zero. If quality control is enabled, the value is DMO_QUALITY_STATUS_ENABLED. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetNow method specifies the earliest time stamp that the DMO will deliver. Reference time specifying the earliest time stamp to deliver. @@ -85,7 +85,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetStatus method enables or disables quality control. Value that specifies whether to enable or disable quality control. Use DMO_QUALITY_STATUS_ENABLED to enable quality control, or zero to disable quality control. @@ -125,7 +125,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDMOQualityControl interface supports quality control on a Microsoft DirectX Media Object (DMO). A DMO exposes this interface if it can respond to late samples. When quality control is enabled, the DMO attempts to process samples on time, discarding late samples if necessary. When quality control is disabled, the DMO processes every sample. By default, quality control is disabled. Applications use this interface to enable or disable quality control. Using quality control is appropriate when you are viewing media data in real time. If you are capturing data to a file, do not enable quality control, because the DMO might discard samples. It does not matter in file capture whether samples arrive late, and you do not want to lose the data. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/IDMOVideoOutputOptimizations.xml b/sources/Interop/Windows/Windows/um/mediaobj/IDMOVideoOutputOptimizations.xml index dc75013e9f..aae1b922ea 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/IDMOVideoOutputOptimizations.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/IDMOVideoOutputOptimizations.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentOperationMode method retrieves the optimization features in effect. Zero-based index of an output stream on the DMO. @@ -58,7 +58,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentSampleRequirements method retrieves the optimization features required to process the next sample, given the features already agreed to by the application. Zero-based index of an output stream on the DMO. @@ -112,7 +112,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryOperationModePreferences method retrieves the DMO's preferred optimization features. Zero-based index of an output stream on the DMO. @@ -166,7 +166,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetOperationMode method notifies the DMO of the optimization features that are in effect. Zero-based index of an output stream on the DMO. @@ -219,7 +219,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDMOVideoOutputOptimizations interface supports video optimizations on a Microsoft DirectX Media Object (DMO). diff --git a/sources/Interop/Windows/Windows/um/mediaobj/IEnumDMO.xml b/sources/Interop/Windows/Windows/um/mediaobj/IEnumDMO.xml index b0dcdcfd3a..1c7d83f3d3 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/IEnumDMO.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/IEnumDMO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] This method is not implemented. Reserved. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Next method retrieves a specified number of items in the enumeration sequence. Number of items to retrieve. @@ -92,14 +92,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reset method resets the enumeration sequence to the beginning. Returns S_OK. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Skip method skips over a specified number of items in the enumeration sequence. Number of items to skip. @@ -107,7 +107,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IEnumDMO interface provides methods for enumerating Microsoft DirectX Media Objects (DMOs). It is based on the OLE enumeration interfaces. For more information, see the IEnumXXXX topic in the Platform SDK. To enumerate registered DMOs, call the function. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/IMediaBuffer.xml b/sources/Interop/Windows/Windows/um/mediaobj/IMediaBuffer.xml index 0cab74c67b..11b877eb4f 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/IMediaBuffer.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/IMediaBuffer.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetBufferAndLength method retrieves the buffer and the size of the valid data in the buffer. Address of a pointer that receives the buffer array. Can be NULL if pcbLength is not NULL. @@ -46,7 +46,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMaxLength method retrieves the maximum number of bytes this buffer can hold. Pointer to a variable that receives the buffer's maximum size, in bytes. @@ -54,7 +54,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetLength method specifies the length of the data currently in the buffer. Size of the data, in bytes. The value must not exceed the buffer's maximum size. Call the method to obtain the maximum size. @@ -62,7 +62,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaBuffer interface provides methods for manipulating a data buffer. Buffers passed to the IMediaObject.ProcessInput and ProcessOutput methods must implement this interface. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/IMediaObject.xml b/sources/Interop/Windows/Windows/um/mediaobj/IMediaObject.xml index bf93817291..f4670867f8 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/IMediaObject.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/IMediaObject.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AllocateStreamingResources method allocates any resources needed by the DMO. Calling this method is always optional. Returns S_OK if successful. Otherwise, returns an HRESULT value indicating the cause of the error. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Discontinuity method signals a discontinuity on the specified input stream. Zero-based index of an input stream on the DMO. @@ -75,21 +75,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Flush method flushes all internally buffered data. Returns S_OK if successful. Otherwise, returns an HRESULT value indicating the cause of the error. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FreeStreamingResources method frees resources allocated by the DMO. Calling this method is always optional. Returns S_OK if successful. Otherwise, returns an HRESULT value indicating the cause of the error. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetInputCurrentType method retrieves the media type that was set for an input stream, if any. Zero-based index of an input stream on the DMO. @@ -154,7 +154,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetInputMaxLatency method retrieves the maximum latency on a specified input stream. Zero-based index of an input stream on the DMO. @@ -219,7 +219,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetInputSizeInfo method retrieves the buffer requirements for a specified input stream. Zero-based index of an input stream on the DMO. @@ -274,7 +274,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetInputStatus method queries whether an input stream can accept more input data. Zero-based index of an input stream on the DMO. @@ -315,7 +315,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetInputStreamInfo method retrieves information about an input stream, such as any restrictions on the number of samples per buffer, and whether the stream performs lookahead on the input data. This information never changes. Zero-based index of an input stream on the DMO. @@ -369,7 +369,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetInputType method retrieves a preferred media type for a specified input stream. Zero-based index of an input stream on the DMO. @@ -448,7 +448,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetOutputCurrentType method retrieves the media type that was set for an output stream, if any. Zero-based index of an output stream on the DMO. @@ -513,7 +513,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetOutputSizeInfo method retrieves the buffer requirements for a specified output stream. Zero-based index of an output stream on the DMO. @@ -567,7 +567,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetOutputStreamInfo method retrieves information about an output stream; for example, whether the stream is discardable, and whether it uses a fixed sample size. This information never changes. Zero-based index of an output stream on the DMO. @@ -621,7 +621,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetOutputType method retrieves a preferred media type for a specified output stream. Zero-based index of an output stream on the DMO. @@ -700,7 +700,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetStreamCount method retrieves the number of input and output streams. Pointer to a variable that receives the number of input streams. Cannot be NULL. @@ -742,7 +742,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Lock method acquires or releases a lock on the DMO. Call this method to keep the DMO serialized when performing multiple operations. Value that specifies whether to acquire or release the lock. If the value is non-zero, a lock is acquired. If the value is zero, the lock is released. @@ -782,7 +782,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ProcessInput method delivers a buffer to the specified input stream. Zero-based index of an input stream on the DMO. @@ -850,7 +850,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ProcessOutput method generates output from the current input data. Bitwise combination of zero or more flags from the enumeration. @@ -930,7 +930,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetInputMaxLatency method sets the maximum latency on a specified input stream. For the definition of maximum latency, see . Zero-based index of an input stream on the DMO. @@ -995,7 +995,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetInputType method sets the media type on an input stream, or tests whether a media type is acceptable. Zero-based index of an input stream on the DMO. @@ -1061,7 +1061,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetOutputType method sets the media type on an output stream, or tests whether a media type is acceptable. Zero-based index of an output stream on the DMO. @@ -1127,7 +1127,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaObject interface provides methods for manipulating a Microsoft DirectX Media Object (DMO). diff --git a/sources/Interop/Windows/Windows/um/mediaobj/IMediaObjectInPlace.xml b/sources/Interop/Windows/Windows/um/mediaobj/IMediaObjectInPlace.xml index 40d96dbf6f..ba90baa389 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/IMediaObjectInPlace.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/IMediaObjectInPlace.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Clone method creates a copy of the DMO in its current state. Address of a pointer to receive the new DMO's interface. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetLatency method retrieves the latency introduced by this DMO. Pointer to a variable that receives the latency, in 100-nanosecond units. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Process method processes a block of data. The application supplies a pointer to a block of input data. The DMO processes the data in place. Size of the data, in bytes. @@ -75,7 +75,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaObjectInPlace interface provides methods for processing data in place. A Microsoft DirectX Media Object (DMO) can expose this interface if it meets the following conditions: diff --git a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_INPUT_DATA_BUFFER_FLAGS.xml b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_INPUT_DATA_BUFFER_FLAGS.xml index d13bf57572..0dc59585fa 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_INPUT_DATA_BUFFER_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_INPUT_DATA_BUFFER_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_INPUT_DATA_BUFFER_FLAGS enumeration defines flags that describe an input buffer. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_INPUT_STREAM_INFO_FLAGS.xml b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_INPUT_STREAM_INFO_FLAGS.xml index 6088437ce8..97e661cdc3 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_INPUT_STREAM_INFO_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_INPUT_STREAM_INFO_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_INPUT_STREAM_INFO_FLAGS enumeration defines flags that describe an input stream. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_OUTPUT_DATA_BUFFER_FLAGS.xml b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_OUTPUT_DATA_BUFFER_FLAGS.xml index 6ba6396d1f..928ee143f5 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_OUTPUT_DATA_BUFFER_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_OUTPUT_DATA_BUFFER_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_OUTPUT_DATA_BUFFER_FLAGS enumeration defines flags that describe an output buffer. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_OUTPUT_STREAM_INFO_FLAGS.xml b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_OUTPUT_STREAM_INFO_FLAGS.xml index 3c7b7c7a0a..299eecbbbf 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_OUTPUT_STREAM_INFO_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_OUTPUT_STREAM_INFO_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_OUTPUT_STREAM_INFO_FLAGS enumeration defines flags that describe an output stream. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_PROCESS_OUTPUT_FLAGS.xml b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_PROCESS_OUTPUT_FLAGS.xml index 47d5710bb1..1032c375d4 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_PROCESS_OUTPUT_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_PROCESS_OUTPUT_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_PROCESS_OUTPUT_FLAGS enumeration defines flags that specify output processing requests. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_SET_TYPE_FLAGS.xml b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_SET_TYPE_FLAGS.xml index fb8f1a2dfa..b41c1115ff 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_SET_TYPE_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_SET_TYPE_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_SET_TYPE_FLAGS enumeration defines flags for setting the media type on a stream. diff --git a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_VIDEO_OUTPUT_STREAM_FLAGS.xml b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_VIDEO_OUTPUT_STREAM_FLAGS.xml index bac9dd7343..4ff3aa6edf 100644 --- a/sources/Interop/Windows/Windows/um/mediaobj/_DMO_VIDEO_OUTPUT_STREAM_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/mediaobj/_DMO_VIDEO_OUTPUT_STREAM_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DMO_VIDEO_OUTPUT_STREAM_FLAGS enumeration defines flags that describe requested features, for video optimizations. diff --git a/sources/Interop/Windows/Windows/um/memoryapi/Windows.xml b/sources/Interop/Windows/Windows/um/memoryapi/Windows.xml index 1a8cb8ddbc..3eee7828ea 100644 --- a/sources/Interop/Windows/Windows/um/memoryapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/memoryapi/Windows.xml @@ -1653,7 +1653,11 @@ A HANDLE to a section that is to be mapped into the address space of the specified process. A HANDLE to a process into which the section will be mapped. - The desired base address of the view. The address is rounded down to the nearest 64k boundary. If this parameter is NULL, the system picks the base address. + + The desired base address of the view. The address is rounded down to the nearest 64k boundary. + If this parameter is <b>NULL</b>, the system picks the base address. + If BaseAddress is not NULL, then any provided must consist of all zeroes. + The offset from the beginning of the section. This must be 64k aligned. The number of bytes to map. A value of zero (0) specifies that the entire section is to be mapped. @@ -1694,7 +1698,7 @@ - Replaces a placeholder with a mapped view. Only data/pf-backed section views are supported (no images, physical memory, etc.). When you replace a placeholder, BaseAddress and ViewSize must exactly match those of the placeholder.After you replace a placeholder with a mapped view, to free that mapped view back to a placeholder, see the UnmapFlags parameter of and .A placeholder is a type of reserved memory region.The 64k alignment requirements on Offset and BaseAddress do not apply when this flag is specified. + Replaces a placeholder with a mapped view. Only data/pf-backed section views are supported (no images, physical memory, etc.). When you replace a placeholder, BaseAddress and ViewSize must exactly match those of the placeholder, and any provided structure must consist of all zeroes.After you replace a placeholder with a mapped view, to free that mapped view back to a placeholder, see the UnmapFlags parameter of and .A placeholder is a type of reserved memory region.The 64k alignment requirements on Offset and BaseAddress do not apply when this flag is specified. @@ -1729,7 +1733,11 @@ A HANDLE to a section that is to be mapped into the address space of the specified process. A HANDLE to a process into which the section will be mapped. - The desired base address of the view. The address is rounded down to the nearest 64k boundary. If this parameter is NULL, the system picks the base address. + + The desired base address of the view. The address is rounded down to the nearest 64k boundary. + If this parameter is <b>NULL</b>, the system picks the base address. + If BaseAddress is not NULL, then any provided structure must consist of all zeroes. + The offset from the beginning of the section. This must be 64k aligned. The number of bytes to map. A value of zero (0) specifies that the entire section is to be mapped. @@ -1770,7 +1778,7 @@ - Replaces a placeholder with a mapped view. Only data/pf-backed section views are supported (no images, physical memory, etc.). When you replace a placeholder, BaseAddress and ViewSize must exactly match those of the placeholder.After you replace a placeholder with a mapped view, to free that mapped view back to a placeholder, see the UnmapFlags parameter of and .A placeholder is a type of reserved memory region. + Replaces a placeholder with a mapped view. Only data/pf-backed section views are supported (no images, physical memory, etc.). When you replace a placeholder, BaseAddress and ViewSize must exactly match those of the placeholder, and any provided structure must consist of all zeroes.After you replace a placeholder with a mapped view, to free that mapped view back to a placeholder, see the UnmapFlags parameter of and .A placeholder is a type of reserved memory region. @@ -2326,7 +2334,7 @@ Unmaps a mapped view of a file from the calling process's address space. - A pointer to the base address of the mapped view of a file that is to be unmapped. This value must be identical to the value returned by a previous call to the or function. + A pointer to the base address of the mapped view of a file that is to be unmapped. This value must be identical to the value returned by a previous call to one of the functions in the family. If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call. @@ -2335,7 +2343,7 @@ Unmaps a previously mapped view of a file or a pagefile-backed section. A HANDLE to the process from which the section will be unmapped. - The base address of a previously mapped view that is to be unmapped. This value must be identical to the value returned by a previous call to . + The base address of a previously mapped view that is to be unmapped. This value must be identical to the value returned by a previous call to one of the functions in the family. This parameter can be zero (0) or one of the following values. @@ -2371,7 +2379,7 @@ - Unmaps a mapped view back to a placeholder (after you've replaced a placeholder with a mapped view using or MapViewOfFile2FromApp). + Unmaps a mapped view back to a placeholder (after you've replaced a placeholder with a mapped view using or MapViewOfFile3FromApp). @@ -2379,7 +2387,7 @@ This is an extended version of that takes an additional flags parameter. - A pointer to the base address of the mapped view of a file that is to be unmapped. This value must be identical to the value returned by a previous call to the or function. + A pointer to the base address of the mapped view of a file that is to be unmapped. This value must be identical to the value returned by a previous call to one of the functions in the family. This parameter can be one of the following values. @@ -2415,7 +2423,7 @@ - Unmaps a mapped view back to a placeholder (after you've replaced a placeholder with a mapped view using or MapViewOfFile2FromApp). + Unmaps a mapped view back to a placeholder (after you've replaced a placeholder with a mapped view using or MapViewOfFile3FromApp). @@ -2613,8 +2621,8 @@ The pointer that specifies a desired starting address for the region of pages that you want to allocate. - If an explicit base address is specified, then it must be a multiple of the system allocation granularity. To determine the size of a page and the allocation granularity on the host computer, use the function. If BaseAddress is NULL, the function determines where to allocate the region. + If BaseAddress is not NULL, then any provided structure must consist of all zeroes, and the base address must be a multiple of the system allocation granularity. To determine the allocation granularity, use the function. If this address is within an enclave that you have not initialized by calling , VirtualAlloc2 allocates a page of zeros for the enclave at that address. The page must be previously uncommitted, and will not be measured with the EEXTEND instruction of the Intel Software Guard Extensions programming model. If the address in within an enclave that you initialized, then the allocation operation fails with the ERROR_INVALID_ADDRESS error. That is true for enclaves that do not support dynamic memory management (i.e. SGX1). SGX2 enclaves will permit allocation, and the page must be accepted by the enclave after it has been allocated. @@ -2673,7 +2681,7 @@ - Replaces a placeholder with a normal private allocation. Only data/pf-backed section views are supported (no images, physical memory, etc.). When you replace a placeholder, BaseAddress and Size must exactly match those of the placeholder.After you replace a placeholder with a private allocation, to free that allocation back to a placeholder, see the dwFreeType parameter of and .A placeholder is a type of reserved memory region. + Replaces a placeholder with a normal private allocation. Only data/pf-backed section views are supported (no images, physical memory, etc.). When you replace a placeholder, BaseAddress and Size must exactly match those of the placeholder, and any provided structure must consist of all zeroes.After you replace a placeholder with a private allocation, to free that allocation back to a placeholder, see the dwFreeType parameter of and .A placeholder is a type of reserved memory region. @@ -2760,8 +2768,8 @@ The pointer that specifies a desired starting address for the region of pages that you want to allocate. - If an explicit base address is specified, then it must be a multiple of the system allocation granularity. To determine the size of a page and the allocation granularity on the host computer, use the function. If BaseAddress is NULL, the function determines where to allocate the region. + If BaseAddress is not NULL, then any provided structure must consist of all zeroes, and the base address must be a multiple of the system allocation granularity. To determine the allocation granularity, use the function. The size of the region of memory to allocate, in bytes. @@ -2818,7 +2826,7 @@ - Replaces a placeholder with a normal private allocation. Only data/pf-backed section views are supported (no images, physical memory, etc.). When you replace a placeholder, BaseAddress and Size must exactly match those of the placeholder.After you replace a placeholder with a private allocation, to free that allocation back to a placeholder, see the dwFreeType parameter of and .A placeholder is a type of reserved memory region. + Replaces a placeholder with a normal private allocation. Only data/pf-backed section views are supported (no images, physical memory, etc.). When you replace a placeholder, BaseAddress and Size must exactly match those of the placeholder, and any provided structure must consist of all zeroes.After you replace a placeholder with a private allocation, to free that allocation back to a placeholder, see the dwFreeType parameter of and .A placeholder is a type of reserved memory region. diff --git a/sources/Interop/Windows/Windows/um/mfapi/Windows.xml b/sources/Interop/Windows/Windows/um/mfapi/Windows.xml index 72e0f2ffa7..72ab1a7444 100644 --- a/sources/Interop/Windows/Windows/um/mfapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/mfapi/Windows.xml @@ -479,7 +479,7 @@ Concatenates a media sample onto another sample if their combined duration does not exceed the specified duration. - A pointer to an to which the the sample provided in the pSampleToAdd parameter is appended. + A pointer to an to which the sample provided in the pSampleToAdd parameter is appended. A pointer to an to append to the sample provided in the pSample parameter. The maximum duration in milliseconds that the combined sample can fill for the operation to be successful. Output parameter that receives a BOOL indicating whether the sample was successfully appended. diff --git a/sources/Interop/Windows/Windows/um/mfidl/IMFTranscodeProfile.xml b/sources/Interop/Windows/Windows/um/mfidl/IMFTranscodeProfile.xml index dab515e624..1ba311dab4 100644 --- a/sources/Interop/Windows/Windows/um/mfidl/IMFTranscodeProfile.xml +++ b/sources/Interop/Windows/Windows/um/mfidl/IMFTranscodeProfile.xml @@ -92,7 +92,7 @@ For example code, see . - Pointer to the interface of an attribute store that contains contains the configuration settings for the video stream. The specified attribute values overwrites any existing values stored in the transcode profile. + Pointer to the interface of an attribute store that contains the configuration settings for the video stream. The specified attribute values overwrites any existing values stored in the transcode profile. The following video attributes can be set: diff --git a/sources/Interop/Windows/Windows/um/mfidl/IMFVideoCaptureSampleAllocator.xml b/sources/Interop/Windows/Windows/um/mfidl/IMFVideoCaptureSampleAllocator.xml index 84723bbdb0..9b4876fa9d 100644 --- a/sources/Interop/Windows/Windows/um/mfidl/IMFVideoCaptureSampleAllocator.xml +++ b/sources/Interop/Windows/Windows/um/mfidl/IMFVideoCaptureSampleAllocator.xml @@ -5,7 +5,7 @@ Initializes the sample allocator with parameters relevant to video capture scenarios. A DWORD specifying the sample size in bytes. The actual sample size used by the allocator is the maximum of the size required by pMediaType and cbSampleSize. - A DWORD specifying the capture metadata size in bytes. Applies only to callers that want to to include additional metadata with the captured frames. The metadata size should include the size of a KSCAMERA_METADATA_ITEMHEADER in addition to the size of the metadata payload itself. + A DWORD specifying the capture metadata size in bytes. Applies only to callers that want to include additional metadata with the captured frames. The metadata size should include the size of a KSCAMERA_METADATA_ITEMHEADER in addition to the size of the metadata payload itself. A DWORD specifying the buffer alignment size in bytes. The default and minimum alignment size is 4KB. Custom alignment sizes less than 4KB will be treated as 4KB. A DWORD specifying the minimum number of pre-allocated samples. This method will fail if the allocator cannot pre-allocate the specified minimum number of samples. diff --git a/sources/Interop/Windows/Windows/um/mfmediaengine/IMFMediaEngineExtension.xml b/sources/Interop/Windows/Windows/um/mfmediaengine/IMFMediaEngineExtension.xml index 449829783a..2eb9640631 100644 --- a/sources/Interop/Windows/Windows/um/mfmediaengine/IMFMediaEngineExtension.xml +++ b/sources/Interop/Windows/Windows/um/mfmediaengine/IMFMediaEngineExtension.xml @@ -4,7 +4,7 @@ Cancels the current request to create an object. - The pointer that was returned in the the ppIUnknownCancelCookie parameter of the method. + The pointer that was returned in the ppIUnknownCancelCookie parameter of the method. If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. diff --git a/sources/Interop/Windows/Windows/um/objidl/IDataObject.xml b/sources/Interop/Windows/Windows/um/objidl/IDataObject.xml index 2e3b2bc402..8e304f204c 100644 --- a/sources/Interop/Windows/Windows/um/objidl/IDataObject.xml +++ b/sources/Interop/Windows/Windows/um/objidl/IDataObject.xml @@ -26,7 +26,7 @@ ADVF_DATAONSTOP - When specified with ADVF_NODATA, this flag causes a last notification with the data included to to be sent before the data object is destroyed.If used without ADVF_NODATA, DAdvise can be implemented in one of the following ways:The ADVF_DATAONSTOP can be ignored.The object can behave as if ADVF_NODATA was specified.A change notification is sent only in the shutdown case. Data changes prior to shutdown do not cause a notification to be sent. + When specified with ADVF_NODATA, this flag causes a last notification with the data included to be sent before the data object is destroyed.If used without ADVF_NODATA, DAdvise can be implemented in one of the following ways:The ADVF_DATAONSTOP can be ignored.The object can behave as if ADVF_NODATA was specified.A change notification is sent only in the shutdown case. Data changes prior to shutdown do not cause a notification to be sent. diff --git a/sources/Interop/Windows/Windows/um/processthreadsapi/Windows.xml b/sources/Interop/Windows/Windows/um/processthreadsapi/Windows.xml index 0a26835fe4..1ca55d99c4 100644 --- a/sources/Interop/Windows/Windows/um/processthreadsapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/processthreadsapi/Windows.xml @@ -77,6 +77,8 @@ Terminal Services:  You cannot inherit handles across sessions. Additionally, if this parameter is TRUE, you must create the process in the same session as the caller. Protected Process Light (PPL) processes:  The generic handle inheritance is blocked when a PPL process creates a non-PPL process since PROCESS_DUP_HANDLE is not allowed from a non-PPL process to a PPL process. See Process Security and Access Rights + + Windows 7:  STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, and STD_ERROR_HANDLE are inherited, even when the parameter is FALSE. The flags that control the priority class and the creation of the process. For a list of values, seeProcess Creation Flags. @@ -200,6 +202,8 @@ Terminal Services:  You cannot inherit handles across sessions. Additionally, if this parameter is TRUE, you must create the process in the same session as the caller. Protected Process Light (PPL) processes:  The generic handle inheritance is blocked when a PPL process creates a non-PPL process since PROCESS_DUP_HANDLE is not allowed from a non-PPL process to a PPL process. See Process Security and Access Rights + + Windows 7:  STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, and STD_ERROR_HANDLE are inherited, even when the parameter is FALSE. The flags that control the priority class and the creation of the process. For a list of values, seeProcess Creation Flags. @@ -323,6 +327,8 @@ Terminal Services:  You cannot inherit handles across sessions. Additionally, if this parameter is TRUE, you must create the process in the same session as the caller. Protected Process Light (PPL) processes:  The generic handle inheritance is blocked when a PPL process creates a non-PPL process since PROCESS_DUP_HANDLE is not allowed from a non-PPL process to a PPL process. See Process Security and Access Rights + + Windows 7:  STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, and STD_ERROR_HANDLE are inherited, even when the parameter is FALSE. The flags that control the priority class and the creation of the process. For a list of values, seeProcess Creation Flags. @@ -1868,11 +1874,12 @@ Retrieves information about the specified process. - A handle to the process. This handle must have the PROCESS_SET_INFORMATION access right. For more information, see Process Security and Access Rights. + A handle to the process. This handle must have at least the PROCESS_QUERY_LIMITED_INFORMATION access right. For more information, see Process Security and Access Rights. A member of the enumeration specifying the kind of information to retrieve. Pointer to an object to receive the type of information specified by the ProcessInformationClass parameter. If the ProcessInformationClass parameter is ProcessMemoryPriority, this parameter must point to a . + If the ProcessInformationClass parameter is ProcessPowerThrottling, this parameter must point to a . If the ProcessInformationClass parameter is ProcessProtectionLevelInfo, this parameter must point to a . If the ProcessInformationClass parameter is ProcessLeapSecondInfo, this parameter must point to a . If the ProcessInformationClass parameter is ProcessAppMemoryInfo, this parameter must point to a . @@ -3695,7 +3702,10 @@ Specifies the thread on which to set the CPU Set assignment. This handle must have the THREAD_SET_LIMITED_INFORMATION access right. The value returned by can also be used. Specifies the list of CPU Set IDs to set as the thread selected CPU set. If this is NULL, the API clears out any assignment, reverting to process default assignment if one is set. Specifies the number of IDs in the list passed in the CpuSetIds argument. If that value is NULL, this should be 0. - This function cannot fail when passed valid parameters. + + If the function succeeds, the return value is nonzero. + This function cannot fail when passed valid parameters. + Sets the minimum size of the stack associated with the calling thread or fiber that will be available during any stack overflow exceptions. This is useful for handling stack overflow exceptions; the application can safely use the specified number of bytes during exception handling. diff --git a/sources/Interop/Windows/Windows/um/projectedfslib/PRJ_PLACEHOLDER_INFO.xml b/sources/Interop/Windows/Windows/um/projectedfslib/PRJ_PLACEHOLDER_INFO.xml index 2321ae34f8..dc2b83bcff 100644 --- a/sources/Interop/Windows/Windows/um/projectedfslib/PRJ_PLACEHOLDER_INFO.xml +++ b/sources/Interop/Windows/Windows/um/projectedfslib/PRJ_PLACEHOLDER_INFO.xml @@ -39,6 +39,6 @@ Start of the variable-length buffer to hold EAs, a custom security descriptor, and alternate data stream information. - Version information for the placeholder (see for more information on PRJ_PLACEHOLDER_VERSION_INFO) + Version information for the placeholder (see for more information on PRJ_PLACEHOLDER_VERSION_INFO). \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/projectedfslib/Windows.xml b/sources/Interop/Windows/Windows/um/projectedfslib/Windows.xml index 3bdb37ae4f..52e1df2c30 100644 --- a/sources/Interop/Windows/Windows/um/projectedfslib/Windows.xml +++ b/sources/Interop/Windows/Windows/um/projectedfslib/Windows.xml @@ -111,7 +111,7 @@ Pointer to a null-terminated unicode string specifying the full path to the virtualization root directory. The provider must have called passing the specified path as the rootPathName parameter and NULL as the targetPathName parameter before calling this routine. This only needs to be done once to designate the path as the virtualization root directory - Pointer to a structure that has been initialized with PrjCommandCallbacksInit and filled in with pointers to the provider's callback functions. + Pointer to a structure that has been filled in with pointers to the provider's callback functions. Pointer to context information defined by the provider for each instance. This parameter is optional and can be NULL. If it is specified, ProjFS will return it in the InstanceContext member of when invoking provider callback routines. An optional pointer to a . On success returns an opaque handle to the ProjFS virtualization instance. The provider passes this value when calling functions that require a PRJ_NAMESPACE_VIRTUALIZATION_CONTEXT as input. diff --git a/sources/Interop/Windows/Windows/um/shdeprecated/IExpDispSupport.xml b/sources/Interop/Windows/Windows/um/shdeprecated/IExpDispSupport.xml index 7c6acaaf4c..dde12b4f6d 100644 --- a/sources/Interop/Windows/Windows/um/shdeprecated/IExpDispSupport.xml +++ b/sources/Interop/Windows/Windows/um/shdeprecated/IExpDispSupport.xml @@ -2,6 +2,20 @@ + + Deprecated. Gets connection points for browser events. + + The IID of the interface on the connection point container whose connection point object is being requested. One of the following values. +

DIID_DWebBrowserEvents

+ Value that indicates a member of the DWebBrowserEvents interface. +

DIID_DWebBrowserEvents2

+ Value that indicates a member of the DWebBrowserEvents2 interface. +

IID_IPropertyNotifySink

+ Value that indicates a member of the interface. + + The address of a pointer to the browser connection point. + If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + Deprecated. Gets ambient properties. A dispatch ID that identifies the member being invoked. diff --git a/sources/Interop/Windows/Windows/um/strmif/ALLOCATOR_PROPERTIES.xml b/sources/Interop/Windows/Windows/um/strmif/ALLOCATOR_PROPERTIES.xml index 0260c384d7..0aa3951180 100644 --- a/sources/Interop/Windows/Windows/um/strmif/ALLOCATOR_PROPERTIES.xml +++ b/sources/Interop/Windows/Windows/um/strmif/ALLOCATOR_PROPERTIES.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ALLOCATOR_PROPERTIES structure describes an allocator's count, size, alignment, and prefix properties. diff --git a/sources/Interop/Windows/Windows/um/strmif/AMCOPPCommand.xml b/sources/Interop/Windows/Windows/um/strmif/AMCOPPCommand.xml index 521e4d685a..fb43282047 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AMCOPPCommand.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AMCOPPCommand.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AMCOPPCommand structure contains a Certified Output Protection Protocol (COPP) command. diff --git a/sources/Interop/Windows/Windows/um/strmif/AMCOPPSignature.xml b/sources/Interop/Windows/Windows/um/strmif/AMCOPPSignature.xml index a44a9be632..a45a57de4f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AMCOPPSignature.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AMCOPPSignature.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AMCOPPSignature structure contains the signature needed for the method. diff --git a/sources/Interop/Windows/Windows/um/strmif/AMCOPPStatusInput.xml b/sources/Interop/Windows/Windows/um/strmif/AMCOPPStatusInput.xml index 93b2b8ef49..c338076d58 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AMCOPPStatusInput.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AMCOPPStatusInput.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AMCOPPStatusInput structure contains a Certified Output Protection Protocol (COPP) status request. diff --git a/sources/Interop/Windows/Windows/um/strmif/AMCOPPStatusOutput.xml b/sources/Interop/Windows/Windows/um/strmif/AMCOPPStatusOutput.xml index 292e537049..435c0fc272 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AMCOPPStatusOutput.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AMCOPPStatusOutput.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AMCOPPStatusOutput structure contains the result of a Certified Output Protection Protocol (COPP) status request. diff --git a/sources/Interop/Windows/Windows/um/strmif/AMOVERLAYFX.xml b/sources/Interop/Windows/Windows/um/strmif/AMOVERLAYFX.xml index 671811da02..1ba02c04d7 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AMOVERLAYFX.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AMOVERLAYFX.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies effects on a DirectDraw hardware overlay surface. diff --git a/sources/Interop/Windows/Windows/um/strmif/AMTunerModeType.xml b/sources/Interop/Windows/Windows/um/strmif/AMTunerModeType.xml index 5b4addc005..2c265346e0 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AMTunerModeType.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AMTunerModeType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the frequency of a TV tuner (cable or antenna). diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_DVD_GRAPH_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/AM_DVD_GRAPH_FLAGS.xml index a7e3d92a8e..d178f866ae 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_DVD_GRAPH_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_DVD_GRAPH_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_DVD_GRAPH_FLAGS enumeration specifies how the DVD Navigator builds a DVD playback graph. These flags are used with the method. diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_DVD_RENDERSTATUS.xml b/sources/Interop/Windows/Windows/um/strmif/AM_DVD_RENDERSTATUS.xml index bf55eca240..d2cf96c998 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_DVD_RENDERSTATUS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_DVD_RENDERSTATUS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_DVD_RENDERSTATUS structure contains codes indicating the status of DVD-Video playback. These codes are used in the method. diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_DVD_STREAM_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/AM_DVD_STREAM_FLAGS.xml index 9a627b8903..710636087e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_DVD_STREAM_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_DVD_STREAM_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Describes a DVD stream type (video, audio, or subpicture). diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_GRAPH_CONFIG_RECONNECT_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/AM_GRAPH_CONFIG_RECONNECT_FLAGS.xml index fd6cb73001..421cb3bab4 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_GRAPH_CONFIG_RECONNECT_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_GRAPH_CONFIG_RECONNECT_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies how to reconnect filters when dynamically rebuilding the filter graph. diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_MEDIA_TYPE.xml b/sources/Interop/Windows/Windows/um/strmif/AM_MEDIA_TYPE.xml index 7b93542da5..4cbae69ae8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_MEDIA_TYPE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_MEDIA_TYPE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_MEDIA_TYPE structure describes the format of a media sample. diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_SAMPLE2_PROPERTIES.xml b/sources/Interop/Windows/Windows/um/strmif/AM_SAMPLE2_PROPERTIES.xml index d26e38eb81..2aa09c6b2e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_SAMPLE2_PROPERTIES.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_SAMPLE2_PROPERTIES.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_SAMPLE2_PROPERTIES structure describes the properties of a media sample. The interface uses this structure. diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_SEEKING_SEEKING_CAPABILITIES.xml b/sources/Interop/Windows/Windows/um/strmif/AM_SEEKING_SEEKING_CAPABILITIES.xml index f31ed49cb0..a726a79e26 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_SEEKING_SEEKING_CAPABILITIES.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_SEEKING_SEEKING_CAPABILITIES.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the seeking capabilities of a media stream. diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_STREAM_INFO.xml b/sources/Interop/Windows/Windows/um/strmif/AM_STREAM_INFO.xml index cf5ecfacb6..0c10a72be4 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_STREAM_INFO.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_STREAM_INFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_STREAM_INFO structure contains stream-control information. diff --git a/sources/Interop/Windows/Windows/um/strmif/AM_STREAM_INFO_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/AM_STREAM_INFO_FLAGS.xml index f9c5077a95..d3ece3dee5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AM_STREAM_INFO_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AM_STREAM_INFO_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_STREAM_INFO_FLAGS enumeration defines flags that indicate a pin's stream-control status. diff --git a/sources/Interop/Windows/Windows/um/strmif/AUDIO_STREAM_CONFIG_CAPS.xml b/sources/Interop/Windows/Windows/um/strmif/AUDIO_STREAM_CONFIG_CAPS.xml index 81ed52b609..9278d3d2d8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AUDIO_STREAM_CONFIG_CAPS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AUDIO_STREAM_CONFIG_CAPS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AUDIO_STREAM_CONFIG_CAPS structure describes a range of audio formats. Audio compression and capture filters use this structure to describe the formats they can produce. diff --git a/sources/Interop/Windows/Windows/um/strmif/AnalogVideoStandard.xml b/sources/Interop/Windows/Windows/um/strmif/AnalogVideoStandard.xml index d9f089c69c..de84437c10 100644 --- a/sources/Interop/Windows/Windows/um/strmif/AnalogVideoStandard.xml +++ b/sources/Interop/Windows/Windows/um/strmif/AnalogVideoStandard.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AnalogVideoStandard enumeration specifies the format of an analog television signal. diff --git a/sources/Interop/Windows/Windows/um/strmif/COLORKEY.xml b/sources/Interop/Windows/Windows/um/strmif/COLORKEY.xml index c9b71c79e7..7c54c564ce 100644 --- a/sources/Interop/Windows/Windows/um/strmif/COLORKEY.xml +++ b/sources/Interop/Windows/Windows/um/strmif/COLORKEY.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The COLORKEY structure communicates color key information between the renderer and another filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/CameraControlFlags.xml b/sources/Interop/Windows/Windows/um/strmif/CameraControlFlags.xml index b5ad4ad360..9fb32facfc 100644 --- a/sources/Interop/Windows/Windows/um/strmif/CameraControlFlags.xml +++ b/sources/Interop/Windows/Windows/um/strmif/CameraControlFlags.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CameraControlFlags enumeration defines whether a camera setting is controlled manually or automatically. diff --git a/sources/Interop/Windows/Windows/um/strmif/CameraControlProperty.xml b/sources/Interop/Windows/Windows/um/strmif/CameraControlProperty.xml index 93be81cc18..aae6171a51 100644 --- a/sources/Interop/Windows/Windows/um/strmif/CameraControlProperty.xml +++ b/sources/Interop/Windows/Windows/um/strmif/CameraControlProperty.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CameraControlProperty enumeration specifies a setting on a camera. diff --git a/sources/Interop/Windows/Windows/um/strmif/CodecAPIEventData.xml b/sources/Interop/Windows/Windows/um/strmif/CodecAPIEventData.xml index 8284f348b3..c232b15600 100644 --- a/sources/Interop/Windows/Windows/um/strmif/CodecAPIEventData.xml +++ b/sources/Interop/Windows/Windows/um/strmif/CodecAPIEventData.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CodecAPIEventData structure contains event data for the EC_CODECAPI_EVENT event. This event is sent by codecs that support the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/CompressionCaps.xml b/sources/Interop/Windows/Windows/um/strmif/CompressionCaps.xml index 59b91632ea..bc79afc0d3 100644 --- a/sources/Interop/Windows/Windows/um/strmif/CompressionCaps.xml +++ b/sources/Interop/Windows/Windows/um/strmif/CompressionCaps.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates video compression capabilities. diff --git a/sources/Interop/Windows/Windows/um/strmif/DDCOLORKEY.xml b/sources/Interop/Windows/Windows/um/strmif/DDCOLORKEY.xml index d90681bc3a..5e7d722d30 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DDCOLORKEY.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DDCOLORKEY.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Describes a color key as a range of values. diff --git a/sources/Interop/Windows/Windows/um/strmif/DECIMATION_USAGE.xml b/sources/Interop/Windows/Windows/um/strmif/DECIMATION_USAGE.xml index 605ac0a4b1..36b3497b82 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DECIMATION_USAGE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DECIMATION_USAGE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Describes the strategy that the Overlay Mixer Filter filter uses to scale the video image down to a smaller size. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_APPMODE.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_APPMODE.xml index 901c450f3d..69d50a0a66 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_APPMODE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_APPMODE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the current audio mode as retrieved in a call to . diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_FORMAT.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_FORMAT.xml index 8f5f87fe3a..06db21f093 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_FORMAT.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_FORMAT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the audio format of a DVD. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_LANG_EXT.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_LANG_EXT.xml index 8c9a43fe58..3ba29d5934 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_LANG_EXT.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_AUDIO_LANG_EXT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines flags that indicate whether an audio stream contains audio language extensions. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_AudioAttributes.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_AudioAttributes.xml index e6c14135a2..f38cae3bd8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_AudioAttributes.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_AudioAttributes.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_AudioAttributes structure is used in to receive the various audio attributes of the disc. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_CMD_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_CMD_FLAGS.xml index 0ed0eb570e..3c37f9f5fc 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_CMD_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_CMD_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines flags that control how the DVD Navigator Filter filter handles command synchronization. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_DECODER_CAPS.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_DECODER_CAPS.xml index ce707992b4..29c6effaae 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_DECODER_CAPS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_DECODER_CAPS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_DECODER_CAPS structure indicates the capabilities of a DVD decoder. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_DISC_SIDE.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_DISC_SIDE.xml index 5ef0a390ae..03f0409f22 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_DISC_SIDE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_DISC_SIDE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the sides of a DVD disc. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_DOMAIN.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_DOMAIN.xml index 80589a6444..867f4938d1 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_DOMAIN.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_DOMAIN.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines the DVD domains. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_FRAMERATE.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_FRAMERATE.xml index d143f5d823..d87ceddc1f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_FRAMERATE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_FRAMERATE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates whether the DVD is authored to play at 25 or 30 frames per second. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_HMSF_TIMECODE.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_HMSF_TIMECODE.xml index f37056b16a..10213aed58 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_HMSF_TIMECODE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_HMSF_TIMECODE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_HMSF_TIMECODE structure gives the hours, minutes, seconds, and frames in a DVD timecode. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_ASSIGNMENT.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_ASSIGNMENT.xml index 6e2ca4b75a..786f0c1f42 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_ASSIGNMENT.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_ASSIGNMENT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines the speaker configuration for an audio stream. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_CONTENTS.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_CONTENTS.xml index 1de3307149..96e38b1580 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_CONTENTS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_CONTENTS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies flags that, when used in a bitwise OR operation, describe the contents of each channel of an audio stream in a karaoke title. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_DOWNMIX.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_DOWNMIX.xml index 7ceb6af4d4..bdd38369db 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_DOWNMIX.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_KARAOKE_DOWNMIX.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines flags used by the method to control which speakers, if any, each auxiliary channel is downmixed to. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_KaraokeAttributes.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_KaraokeAttributes.xml index 4b8d68762e..37f0064e80 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_KaraokeAttributes.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_KaraokeAttributes.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_KaraokeAttributes structure contains information about a karaoke audio stream. The method fills in a DVD_KaraokeAttributes structure for a specified stream. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_MENU_ID.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_MENU_ID.xml index e1f02fd1fb..d8a1b3e22b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_MENU_ID.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_MENU_ID.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the DVD menu in a call to . diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_MUA_Coeff.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_MUA_Coeff.xml index 64e8885c97..f808236e95 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_MUA_Coeff.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_MUA_Coeff.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The structure contains an array of eight DVD_MUA_Coeff structures, one for each channel in the stream. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_MUA_MixingInfo.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_MUA_MixingInfo.xml index f49fed9bd6..57e19bcf17 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_MUA_MixingInfo.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_MUA_MixingInfo.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_MUA_MixingInfo structure describes the surround sound mixing information for the channels in one audio stream in a specified title. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_MenuAttributes.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_MenuAttributes.xml index 9a836983e9..e115cd7b44 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_MenuAttributes.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_MenuAttributes.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_MenuAttributes structure contains information about a DVD menu. The method fills in a DVD_MenuAttributes structure for a specified stream. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_MultichannelAudioAttributes.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_MultichannelAudioAttributes.xml index 361b88c69a..d8f5d4e7b4 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_MultichannelAudioAttributes.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_MultichannelAudioAttributes.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_MultichannelAudioAttributes structure describes the multichannel attributes of one audio stream within a specified title. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_NavCmdType.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_NavCmdType.xml index 64ccf4f0a6..f12b1d1a7a 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_NavCmdType.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_NavCmdType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines DVD navigation command types. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_PARENTAL_LEVEL.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_PARENTAL_LEVEL.xml index 1964ed23c1..e82b56308b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_PARENTAL_LEVEL.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_PARENTAL_LEVEL.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Identifies flags for the generic parental levels defined in the DVD specification. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_PLAYBACK_LOCATION.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_PLAYBACK_LOCATION.xml index 451fb2629f..ef0d47f35b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_PLAYBACK_LOCATION.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_PLAYBACK_LOCATION.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_PLAYBACK_LOCATION structure indicates DVD playback location. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_PLAYBACK_LOCATION2.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_PLAYBACK_LOCATION2.xml index 7c901b32bb..a31ec15c02 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_PLAYBACK_LOCATION2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_PLAYBACK_LOCATION2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_PLAYBACK_LOCATION2 structure indicates DVD playback location. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_PREFERRED_DISPLAY_MODE.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_PREFERRED_DISPLAY_MODE.xml index 6e5fc162a7..6fa36e80e8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_PREFERRED_DISPLAY_MODE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_PREFERRED_DISPLAY_MODE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  Deprecated.
Indicates the user's preferred window aspect ratio and conversion method. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_RELATIVE_BUTTON.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_RELATIVE_BUTTON.xml index 4fccfda854..df8f42b694 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_RELATIVE_BUTTON.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_RELATIVE_BUTTON.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Identifies the four directional buttons used for DVD menu navigation and other operations. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_CODING.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_CODING.xml index 18cc19c26b..68cf743ca6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_CODING.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_CODING.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates what kind of content the subpicture stream contains. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_LANG_EXT.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_LANG_EXT.xml index a42152efc8..eb8b020d65 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_LANG_EXT.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_LANG_EXT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines the possible language extensions in a specified subpicture stream. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_TYPE.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_TYPE.xml index 5cc55436a5..22467faf14 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_TYPE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_SUBPICTURE_TYPE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines flags used to determine what kind of content the subpicture stream contains. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_SubpictureAttributes.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_SubpictureAttributes.xml index 5f297d425d..7c725ac213 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_SubpictureAttributes.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_SubpictureAttributes.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_SubpictureAttributes structure contains information about the DVD subpicture. The method fills in a DVD_SubpictureAttributes structure for a specified stream. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_TIMECODE.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_TIMECODE.xml index 5ff8c6a5f8..befa8fcfb5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_TIMECODE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_TIMECODE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_TIMECODE structure contains DVD timecode in hours, minutes, seconds, and frames. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_TIMECODE_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_TIMECODE_FLAGS.xml index 156b922fe5..069358e120 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_TIMECODE_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_TIMECODE_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the frame rate at which a DVD has been authored to play. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_TITLE_APPMODE.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_TITLE_APPMODE.xml index 2bb3f8a276..2d12a2d4fd 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_TITLE_APPMODE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_TITLE_APPMODE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates whether a DVD title is a karaoke title. This enumeration is a member of the structure, which is filled when an application calls the method. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_TextCharSet.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_TextCharSet.xml index 807f33ed27..ed83692cc4 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_TextCharSet.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_TextCharSet.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines which character set a specified string is encoded with. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_TextStringType.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_TextStringType.xml index 5f04d0ee9b..d7ad2ab5b8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_TextStringType.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_TextStringType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines a subset of the DVD text-string types. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_TitleAttributes.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_TitleAttributes.xml index c683b903bd..92b755e28b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_TitleAttributes.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_TitleAttributes.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_TitleAttributes structure contains information about a DVD title. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_VIDEO_COMPRESSION.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_VIDEO_COMPRESSION.xml index ccaeb78927..b66e6b1aba 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_VIDEO_COMPRESSION.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_VIDEO_COMPRESSION.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines the possible DVD video compression types. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVD_VideoAttributes.xml b/sources/Interop/Windows/Windows/um/strmif/DVD_VideoAttributes.xml index 0d72705a86..da5a345d7b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVD_VideoAttributes.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVD_VideoAttributes.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVD_VideoAttributes structure describes the attributes of the video stream for the current title or menu. diff --git a/sources/Interop/Windows/Windows/um/strmif/DVINFO.xml b/sources/Interop/Windows/Windows/um/strmif/DVINFO.xml index b3932e9a2d..07930ceeb2 100644 --- a/sources/Interop/Windows/Windows/um/strmif/DVINFO.xml +++ b/sources/Interop/Windows/Windows/um/strmif/DVINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DVINFO structure describes the format of a digital video (DV) stream. diff --git a/sources/Interop/Windows/Windows/um/strmif/FILTER_INFO.xml b/sources/Interop/Windows/Windows/um/strmif/FILTER_INFO.xml index 61bc58d7a4..5ee2cf90c5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/FILTER_INFO.xml +++ b/sources/Interop/Windows/Windows/um/strmif/FILTER_INFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FILTER_INFO structure contains information about a filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/FILTER_STATE.xml b/sources/Interop/Windows/Windows/um/strmif/FILTER_STATE.xml index 073d8b8487..09f8c72841 100644 --- a/sources/Interop/Windows/Windows/um/strmif/FILTER_STATE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/FILTER_STATE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies a filter's state or the state of the filter graph. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMAnalogVideoDecoder.xml b/sources/Interop/Windows/Windows/um/strmif/IAMAnalogVideoDecoder.xml index 30d98f384c..4157530804 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMAnalogVideoDecoder.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMAnalogVideoDecoder.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_AvailableTVFormats method retrieves the analog video formats that the decoder supports. Pointer to a variable that receives a bitwise enumeration. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_HorizontalLocked method determines whether the horizontal sync is locked. @@ -68,7 +68,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_NumberOfLInes method retrieves the number of scan lines in the video signal. Pointer to a variable that receives the number of scan lines in the video signal. This is generally by 525 lines for NTSC and 625 lines for PAL or SECAM. @@ -108,7 +108,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_OutputEnable method determines whether the video port bus is enabled. @@ -164,7 +164,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_TVFormat method retrieves the current analog video format. Pointer to a variable that receives a member of the enumeration, indicating the analog video format. @@ -172,7 +172,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_VCRHorizontalLocking method indicates whether the decoder is expecting video from a tape source or a broadcast source. @@ -228,7 +228,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_OutputEnable method enables or disables the video port bus. @@ -284,7 +284,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_TVFormat method sets the analog video format. Specifies the video format as a member of the enumeration. @@ -292,7 +292,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_VCRHorizontalLocking method specifies whether the video is a tape source or a broadcast source. @@ -348,7 +348,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMAnalogVideoDecoder interface sets and retrieves information about the analog-to-digital conversion process in a video capture filter. The WDM Video Capture filter exposes this interface if the device is an analog video capture device. Applications can use this interface to control aspects of the analog decoding process, such as the analog video format and the horizontal sync lock. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMAnalogVideoEncoder.xml b/sources/Interop/Windows/Windows/um/strmif/IAMAnalogVideoEncoder.xml index c627d0d388..1a6312422e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMAnalogVideoEncoder.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMAnalogVideoEncoder.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMAnalogVideoEncoder interface is deprecated.
The get_AvailableTVFormats method retrieves the analog video standards (NTSC/M, PAL/B, SECAM/K1, and so on) supported by the encoder. Specifies a pointer to a enumeration and the available formats have been combined in this integer with a bitwise OR. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMAnalogVideoEncoder interface is deprecated.
The get_CCEnable determines whether closed captioning on the encoder is currently enabled. @@ -36,15 +36,15 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMAnalogVideoEncoder interface is deprecated.
The get_CopyProtection method determines whether copy protection is currently enabled on the encoder. - Specifies a pointer to a long integer to receive the current copy protection level, as defined in the enumeration. + Specifies a pointer to a long integer to receive the current copy protection level, as defined in the AM_COPY_MACROVISION_LEVEL enumeration. When this method succeeds, it returns S_OK. Otherwise it returns an HRESULT - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMAnalogVideoEncoder interface is deprecated.
The get_TVFormat method retrieves the analog video standard that the encoder is currently set to (NTSC/M, PAL/B, SECAM/K1, and so on). Specifies a pointer to a long integer to receive the encoder's current video standard. @@ -52,7 +52,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMAnalogVideoEncoder interface is deprecated.
The put_CCEnable method enables or disables closed captioning. @@ -76,7 +76,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMAnalogVideoEncoder interface is deprecated.
The put_CopyProtection method sets the level of copy protection for the encoder. Specifies the level of copy protection as a long integer with a value as defined in the AM_COPY_MACROVISION_LEVEL enumeration. @@ -84,7 +84,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMAnalogVideoEncoder interface is deprecated.
The put_TVFormat method sets the encoder to a particular analog video standard (NTSC/M, PAL/B, SECAM/K1, and so on). Specifies the video standard to set in the encoder as a enumeration. @@ -92,7 +92,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated.
diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMAsyncReaderTimestampScaling.xml b/sources/Interop/Windows/Windows/um/strmif/IAMAsyncReaderTimestampScaling.xml index 43270f771d..c426d94de4 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMAsyncReaderTimestampScaling.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMAsyncReaderTimestampScaling.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Gets the filter's time-stamping mode. @@ -48,7 +48,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Sets the filter's time-stamping mode. @@ -91,7 +91,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Enables a pull-mode source filter to support larger file sizes. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMAudioInputMixer.xml b/sources/Interop/Windows/Windows/um/strmif/IAMAudioInputMixer.xml index 8ac30c2a95..4b9a02a440 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMAudioInputMixer.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMAudioInputMixer.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Bass method retrieves the bass equalization. Receives the bass gain, in decibels. A negative value indicates attenuation. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_BassRange method retrieves the bass range. Receives the largest valid value for the method. For example, 6.0 means that any value between –6.0 and 6.0 is valid. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Enable method retrieves whether the input is enabled. @@ -93,7 +93,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Loudness method retrieves the loudness control setting. @@ -121,7 +121,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_MixLevel method retrieves the recording level. @@ -145,7 +145,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Mono method queries whether all channels are combined into a mono signal. @@ -173,11 +173,11 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Pan method retrieves the pan level. - Receives the pan level. Possible values range from from –1.0 to 1.0, as follows: + Receives the pan level. Possible values range from –1.0 to 1.0, as follows: Value @@ -201,7 +201,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Treble method retrieves the treble equalization. Receives the treble gain, in decibels. A negative value indicates attenuation. @@ -209,7 +209,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_TrebleRange method retrieves the treble range for this input. Receives the largest valid value for the . For example, 6.0 means that any value between –6.0 and 6.0 is valid. @@ -217,7 +217,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Bass method sets the bass equalization. Specifies the gain, in decibels. A negative value specifies attenuation. @@ -257,7 +257,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Enable method enables or disables an input. @@ -317,7 +317,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Loudness method enables or disables the loudness control. @@ -345,7 +345,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_MixLevel method sets the recording level for this input. @@ -413,7 +413,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Mono method combines all channels into a mono signal. @@ -473,7 +473,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Pan method sets the pan level. @@ -501,7 +501,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Treble method sets the treble equalization for this input. Specifies the gain, in decibels. A negative value specifies attenuation. @@ -541,7 +541,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMAudioInputMixer interface controls audio capture properties, such as panning and loudness; and enables or disables specific audio inputs, such as the line in or the microphone. The Audio Capture filter exposes this interface on each input pin, as well as on the filter itself. The input pins on the Audio Capture Filter represent physical hardware connections; they are not connected to other DirectShow filters. The pin name indicates the input type; for example, "Line In" or "Microphone." Use the IAMAudioInputMixer interface as follows: diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMAudioRendererStats.xml b/sources/Interop/Windows/Windows/um/strmif/IAMAudioRendererStats.xml index 8646cd5add..9d691b5dc4 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMAudioRendererStats.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMAudioRendererStats.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetStatParam method retrieves performance information from the audio renderer. Specifies a member of the enumeration, indicating which information to retrieve. @@ -83,7 +83,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMAudioRendererStats interface retrieves statistical performance information from an audio renderer filter. This interface is intended for use during development, to log performance data from the audio renderer. There is probably no reason for an application to use it in a retail build. The Audio Renderer (WaveOut) filter and the DirectSound Renderer filter both expose this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMBufferNegotiation.xml b/sources/Interop/Windows/Windows/um/strmif/IAMBufferNegotiation.xml index 9f5a5eb987..ae129a168e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMBufferNegotiation.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMBufferNegotiation.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAllocatorProperties method retrieves the allocator properties that the pin is using. Pointer to an structure, allocated by the caller, that receives the allocator properties. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SuggestAllocatorProperties method informs the pin of the application's preferred allocator properties. Call this method before the pin connects. Pointer to an structure that contains the requested properties. A negative value for any member indicates that the pin should use its default setting for that property. @@ -122,7 +122,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMBufferNegotiation interface requests the number of buffers for a filter to create and size of each buffer. This interface can be exposed by any pin that connects using the pin interface, but is typically exposed on the output pins of capture filters. When two pins connect through IMemInputPin, they agree on an allocator object that is responsible for creating buffers. Normally this process is transparent to the application, but in some situations the application needs more control. If a pin exposes IAMBufferNegotiation, the application can suggest how many buffers to create, the size of the buffers, and other properties. If your application performs preview of captured audio, you can specify a smaller buffer size to reduce latency. Teleconferencing applications should specify a minimal number of buffers. To use this interface, call the SuggestAllocatorProperties method before the pins connect. After the pins connect, call the GetAllocatorProperties method to determine whether the pin honored the request. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMCameraControl.xml b/sources/Interop/Windows/Windows/um/strmif/IAMCameraControl.xml index 56c2aede77..27ef0bbb11 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMCameraControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMCameraControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Get method gets the current setting of a camera property. Specifies the property to retrieve, as a value from the enumeration. @@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetRange method gets the range and default value of a specified camera property. Specifies the property to query, as a value from the enumeration. @@ -27,7 +27,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Set method sets a specified property on the camera. Specifies the property to set, as a value from the enumeration. @@ -37,7 +37,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMCameraControl interface controls camera settings such as zoom, pan, aperture adjustment, or shutter speed. To obtain this interface, query the filter that controls the camera. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMCertifiedOutputProtection.xml b/sources/Interop/Windows/Windows/um/strmif/IAMCertifiedOutputProtection.xml index c7f038f427..6250de112d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMCertifiedOutputProtection.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMCertifiedOutputProtection.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The KeyExchange method returns the graphics driver's certificate. Receives a 128-bit random number, generated by the graphics driver. Use this value in the method. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ProtectionCommand method sends a COPP command to the graphics driver. Pointer to an structure that contains the command. @@ -122,7 +122,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ProtectionStatus method sends a COPP status request to the graphics driver. Pointer to an structure that contains the status request. @@ -175,7 +175,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SessionSequenceStart method initiates the COPP session with the graphics driver. Pointer to an structure. Fill this structure as described in the Remarks session. @@ -227,7 +227,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMCertifiedOutputProtection interface sends Certified Output Protection Protocol (COPP) messages to the graphics driver. This interface is exposed by the Video Mixing Renderer 7 (VMR-7) and Video Mixing Renderer 9 (VMR-9) filters. For information about using COPP, see Using Certified Output Protection Protocol (COPP). diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMClockAdjust.xml b/sources/Interop/Windows/Windows/um/strmif/IAMClockAdjust.xml index 099de3c466..8ab78839bd 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMClockAdjust.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMClockAdjust.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetClockDelta method adjusts the clock time. Specifies the amount by which to adjust the clock, as a REFERENCE_TIME value. A positive value moves the clock forward, and a negative value moves the clock backward. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMClockAdjust interface adjusts the reference clock. The System Reference Clock exposes this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMClockSlave.xml b/sources/Interop/Windows/Windows/um/strmif/IAMClockSlave.xml index a884aa7709..b6dc6ca647 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMClockSlave.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMClockSlave.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetErrorTolerance method retrieves the audio renderer's rate-matching tolerance. Pointer to a variable that receives the maximum tolerance, in milliseconds. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetErrorTolerance method sets the audio renderer's rate-matching tolerance. Specifies the maximum tolerance, in milliseconds. The value must be from 1 to 1000, inclusive. @@ -97,7 +97,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMClockSlave interface controls the tolerance of an audio renderer when it is matching rates with another clock. If the audio renderer is matching rates with another clock, it allows the audio to drift up to the amount of the specified tolerance. If the audio drifts too far ahead, the renderer drops samples; if it drifts too far behind, the renderer inserts silent gaps. This interface enables an application to change the tolerance from the default. Setting a larger tolerance is likely to result in the audio stream becoming out of sync with the video stream. Setting a smaller tolerance can cause audio jitter. Therefore, changing the tolerance setting is not recommended, unless you have a specific reason to do so. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMCopyCaptureFileProgress.xml b/sources/Interop/Windows/Windows/um/strmif/IAMCopyCaptureFileProgress.xml index 4d16957066..37a2c187e8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMCopyCaptureFileProgress.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMCopyCaptureFileProgress.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Progress method is called periodically by the method while it copies the file. Specifies the percentage of the copy operation that has completed, as a value between 0 and 100. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMCopyCaptureFileProgress interface is a callback interface used by the method. Because the CopyCaptureFile method can take a long time to complete, an application can implement this interface to receive periodic notifications about the progress of the copy operation. If the application does not need to receive this information, there is no need to implement the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMCrossbar.xml b/sources/Interop/Windows/Windows/um/strmif/IAMCrossbar.xml index 4c600ce877..d782e8f74e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMCrossbar.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMCrossbar.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CanRoute method queries whether a specified input pin can be routed to a specified output pin. Specifies the index of the output pin. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_CrossbarPinInfo method retrieves information about a specified pin. @@ -137,7 +137,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_IsRoutedTo method retrieves the input pin that is currently routed to the specified output pin. Specifies the index of the output pin. @@ -191,7 +191,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_PinCounts method retrieves the number of input and output pins on the crossbar filter. Pointer to variable that receives the number of output pins. @@ -233,7 +233,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Route method routes an input pin to an output pin. Specifies the index of the output pin. @@ -274,7 +274,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMCrossbar interface routes signals from an analog or digital source to a video capture filter. This interface is implemented by the Analog Video Crossbar Filter. The Analog Video Crossbar filter is modeled after a general switching matrix, with n inputs and m outputs. For example, a video card might have two external connectors: a coaxial connector for TV, and an S-video input. These would be represented as input pins on the filter. To select one of the inputs, an application would use the IAMCrossbar interface to "route" an input pin to the filter's output pin, by calling the method. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMDecoderCaps.xml b/sources/Interop/Windows/Windows/um/strmif/IAMDecoderCaps.xml index 97578ae1f4..6516f4dccd 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMDecoderCaps.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMDecoderCaps.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDecoderCaps method queries the decoder for its capabilities. @@ -73,7 +73,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMDecoderCaps interface returns capabilities information from an MPEG decoder filter. The capabilities reported through this interface include whether the decoder supports the Video Mixing Renderer filter and whether it supports DirectX Video Acceleration. Some DirectShow components, such as the DVD Graph Builder, use this interface to determine the correct filter graph to build. Applications might use this interface to query the decoder's capabilities. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMDevMemoryAllocator.xml b/sources/Interop/Windows/Windows/um/strmif/IAMDevMemoryAllocator.xml index 589dbf46fb..0fd1e7e3bc 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMDevMemoryAllocator.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMDevMemoryAllocator.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMDevMemoryAllocator interface is deprecated.
Allocates a memory buffer. Pointer that will receive the address of the allocated memory buffer. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMDevMemoryAllocator interface is deprecated.
Tests whether the specific instance (device) of the allocator allocated a memory pointer. Pointer to the allocated memory buffer's address. @@ -21,7 +21,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMDevMemoryAllocator interface is deprecated.
Frees the previously allocated memory. Pointer to the allocated memory. @@ -29,7 +29,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMDevMemoryAllocator interface is deprecated.
Retrieves an IUnknown interface pointer to a device memory control object that can be aggregated with a custom allocator. Address of a pointer to the newly created control object's own IUnknown. This inner IUnknown interface should be released when the outer object is destroyed. The custom allocator should call the QueryInterface method on this pointer to obtain the interface. @@ -38,7 +38,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMDevMemoryAllocator interface is deprecated.
Retrieves information about the memory capabilities. Pointer to the total free memory size. @@ -49,7 +49,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface is no longer supported by the AVI Splitter.
diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMDevMemoryControl.xml b/sources/Interop/Windows/Windows/um/strmif/IAMDevMemoryControl.xml index 2d35cf7af0..1d4a40e742 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMDevMemoryControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMDevMemoryControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMDevMemoryControl interface is deprecated.
Retrieves the device ID of the on-board memory allocator. Pointer to the device ID. @@ -12,14 +12,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMDevMemoryControl interface is deprecated.
Checks if the memory supported by the allocator requires the use of the method. Returns S_OK if the method is required, or S_FALSE otherwise. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMDevMemoryControl interface is deprecated.
Used to synchronize with the completed write. This method returns when any data being written to the particular allocator region is fully written into the memory. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface is no longer supported by the AVI Splitter.
diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMDeviceRemoval.xml b/sources/Interop/Windows/Windows/um/strmif/IAMDeviceRemoval.xml index 97efbf5004..1bd710ef10 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMDeviceRemoval.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMDeviceRemoval.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DeviceInfo method retrieves information about the device. Receives a GUID that specifies the device interface class. @@ -13,21 +13,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Disassociate method disassociates the KsProxy filter from the device by closing the device handle. The Filter Graph Manager calls this method if it receives a notification that the device was removed. If the method succeeds, it returns S_OK. Otherwise it returns an HRESULT error code. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reassociate method reassociates the KsProxy filter with the device. The Filter Graph Manager calls this method if it receives a notification that the device has returned after being removed. If the method succeeds, it returns S_OK. Otherwise it returns an HRESULT error code. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMDeviceRemoval interface provides a way for the Filter Graph Manager to register for device removal events for a capture device. The KsProxy filter exposes this interface. (See WDM Video Capture Filter.) Applications typically do not use this interface, and third-party filters do not need to implement this interface. To get a pointer to this interface, call QueryInterface on the KsProxy filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMDroppedFrames.xml b/sources/Interop/Windows/Windows/um/strmif/IAMDroppedFrames.xml index e3b478f986..1ad614b226 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMDroppedFrames.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMDroppedFrames.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAverageFrameSize method retrieves the average size of the frames that the filter has captured. Pointer to a variable that receives the average frame size, in bytes, since the filter began streaming. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDroppedInfo method retrieves an array of frame numbers that were dropped. Specifies the size of the array. @@ -136,7 +136,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNumDropped method retrieves the total number of frames that the filter has dropped since it started streaming. Pointer to a variable that receives the number of dropped frames. @@ -177,7 +177,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNumNotDropped method retrieves the total number of frames that the filter has delivered since it started streaming. Pointer to a variable that receives the number of delivered frames. @@ -218,7 +218,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMDroppedFrames interface retrieves performance information from a video capture filter, including how many frames were dropped and how many were delivered. Applications can use this interface to determine capture performance at run-time. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMExtDevice.xml b/sources/Interop/Windows/Windows/um/strmif/IAMExtDevice.xml index cdf672864d..64216b7e0c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMExtDevice.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMExtDevice.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Calibrate method calibrates an external device's transport mechanism. This method is not implemented. @@ -53,7 +53,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCapability method retrieves the capabilities of the external device. Specifies the capability to check. See Remarks for more information. @@ -63,7 +63,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_DevicePort method retrieves the communication port to which the external device is connected. @@ -115,7 +115,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_DevicePower method retrieves the external device's power mode. @@ -143,7 +143,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_ExternalDeviceID method retrieves the model number of the external device. Pointer to an LPOLESTR that receives the manufacturer-specific identification as a string. The caller must release the string by calling . @@ -151,7 +151,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_ExternalDeviceVersion retrieves the version number of the external device's operating software. Pointer to an LPOLESTR that receives the manufacturer-specific operating software version number as a string. The caller must release the string by calling . @@ -159,7 +159,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_DevicePort method assigns the communication port to which the external device is connected. This method is not implemented. @@ -216,7 +216,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_DevicePower method assigns the external device's power mode to either on, off, or standby. @@ -244,7 +244,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMExtDevice interface controls an external device, such as a DV camera or video tape recoder (VTR). This interface controls basic device functions. Several other interfaces exist for controlling more specific functionality in a device: diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMExtTransport.xml b/sources/Interop/Windows/Windows/um/strmif/IAMExtTransport.xml index 3ec2cabb69..f60f45d8f8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMExtTransport.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMExtTransport.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetBump method retrieves the status of bump mode. This method is not implemented. @@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCapability method retrieves the general capabilities of the transport. Specifies the capability to check. See Remarks for more information. @@ -24,7 +24,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetChase method retrieves the status of chase mode. This method is not implemented. @@ -51,7 +51,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetEditProperty method retrieves parameters and values associated with an edit event. This method is not implemented. @@ -62,7 +62,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetEditPropertySet method retrieves the state of an edit event. This method is not implemented. @@ -92,7 +92,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetStatus method returns information about the transport's status. Specifies the status information to retrieve. See Remarks for more information. @@ -101,7 +101,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTransportAudioParameters method retrieves audio parameter setting for external transport. This method is not implemented. @@ -139,7 +139,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTransportBasicParameters method retrieves general properties of the external transport. Specifies which property to receive. @@ -149,7 +149,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTransportVideoParameters retrieves video parameter settings for external transport. This method is not implemented. @@ -175,7 +175,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_AntiClogControl method determines whether the anti-headclog control is enabled or disabled. This method is not implemented. @@ -200,7 +200,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_EditStart method determines whether the external transport's edit control is active. This method is not implemented. @@ -225,7 +225,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_LocalControl method determines whether the transport is under local control or remote control. This method is not implemented. @@ -250,7 +250,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_MediaState method retrieves the current state of the media. This method is not implemented. @@ -279,7 +279,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Mode method retrieves the current transport mode, such as play, stop, or record. Pointer to a long integer that receives the current transport mode. For possible values, see . @@ -287,7 +287,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Rate method retrieves the playback rate for variable-speed external devices. This method is not implemented. @@ -296,7 +296,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_AntiClogControl method enables or disables anti-headclog control on the transport. This method is not implemented. @@ -321,7 +321,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_EditStart method activates the edit control on a capable transport. This method is not implemented. @@ -346,7 +346,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_LocalControl method switches the device between local and remote control. This method is not implemented. @@ -371,7 +371,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_MediaState method sets the current state of the media. @@ -398,7 +398,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Mode method sets the transport mode; for example, play, stop, or record. @@ -506,7 +506,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Rate method sets the playback rate for variable-speed external devices. This method is not implemented. @@ -515,7 +515,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetBump method temporarily changes the playback, for synchronization of multiple external devices. This method is not implemented. @@ -525,7 +525,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetChase method enables or disables chase mode. This method is not implemented. @@ -552,7 +552,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetEditProperty method defines parameters and values associated with an edit event. This method is not implemented. @@ -563,7 +563,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTransportAudioParameters assigns audio parameter settings for external transport. This method is not implemented. @@ -601,7 +601,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTransportBasicParameters method sets general properties of the transport. Specifies which property to set. See Remarks for more information. @@ -643,7 +643,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTransportVideoParameters method assigns video parameters for external transport. This method is not implemented. @@ -669,7 +669,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMExtTransport interface controls the transport on a video tape recporder (VTR) or camcorder. Applications can use this interface to play, record, or stop the transport; determine whether the transport contains media; and other transport-related functions. The implementation of this interface can vary, depending on the device. Some methods might return E_NOTIMPL if the device does not support them. This interface also contains methods for non-linear editing through edit events and edit property sets. Currently, DirectShow does not provide any filters or drivers that implement this part of the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMFilterGraphCallback.xml b/sources/Interop/Windows/Windows/um/strmif/IAMFilterGraphCallback.xml index 105b92371f..d3c6be8ee6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMFilterGraphCallback.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMFilterGraphCallback.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UnableToRender method is called by the Filter Graph Manager if it cannot find any combination of filters to render the specified pin. Specifies the interface of the pin that could not be rendered. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMFilterGraphCallback interface provides a callback mechanism during graph building. To use this interface, implement the interface in your application or client object. Query the Filter Graph Manager for the IObjectWithSite interface and call the IObjectWithSite.SetSite method with a pointer to your implementation of the interface. During graph building, if the Filter Graph Manager fails to render a pin, it calls the UnabletoRender method. The client can then take appropriate action, such as providing an error message for the user or registering a new filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMFilterMiscFlags.xml b/sources/Interop/Windows/Windows/um/strmif/IAMFilterMiscFlags.xml index 83f4ff5a2f..c7738f1e1d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMFilterMiscFlags.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMFilterMiscFlags.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMiscFlags method returns the filter's type, either source or renderer. This method returns a member of the enumeration. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMFilterMiscFlags interface queries whether a filter is a source filter or a renderer. Source and renderer filters should implement this interface. Applications do not use this interface. The Filter Graph Manager uses this interface to determine how many EC_COMPLETE events it will receive when playback completes. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMGraphBuilderCallback.xml b/sources/Interop/Windows/Windows/um/strmif/IAMGraphBuilderCallback.xml index fd44b291dd..4597bcac54 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMGraphBuilderCallback.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMGraphBuilderCallback.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Filter Graph Manager calls this method after it has created a filter, but before it attempts to connect the filter. Pointer to the interface of the filter. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Filter Graph Manager calls this method when it finds a candidate filter for the graph, but before it creates the filter. Pointer to a moniker that contains information about the filter. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMGraphBuilderCallback interface provides a callback mechanism during graph building. To use this interface, implement the interface in your application or client object. Query the Filter Graph Manager for the IObjectWithSite interface and call the IObjectWithSite.SetSite method with a pointer to your implementation of the interface. The Filter Graph Manager calls the methods on this interface while it builds the graph, which gives the client the opportunity to modify the graph-building process. The primary use for this interface is to configure the Video Mixing Renderer filter before it is connected. You can also use it reject a specific filter during graph building, such as a decoder filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMGraphStreams.xml b/sources/Interop/Windows/Windows/um/strmif/IAMGraphStreams.xml index c75657b478..20d017c8aa 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMGraphStreams.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMGraphStreams.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FindUpstreamInterface method searches the filter graph for a specified interface, upstream from a specified pin. Pointer to the interface of a pin. The pin must belong to a filter in the filter graph. @@ -59,7 +59,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMaxGraphLatency method sets the maximum latency for the graph. You must call the method before calling this method. Specifies the maximum latency in 100-nanosecond units. @@ -99,7 +99,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SyncUsingStreamOffset method enables or disables synchronization using time-stamp offsets. Boolean value indicating whether to use a time-stamp offset. If TRUE, live sources will use a time-stamp offset to synchronize streams. @@ -107,7 +107,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMGraphStreams interface controls a filter graph that renders a live source. A live source is one that streams data in real time, such as a capture device or a network broadcast. The Filter Graph Manager implements this interface. Applications can use this interface to specify how the graph handles latency and synchronization when it renders a live source. For more information, see Live Sources. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMLatency.xml b/sources/Interop/Windows/Windows/um/strmif/IAMLatency.xml index b6af85a95c..db2d625c56 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMLatency.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMLatency.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetLatency method retrieves the expected latency associated with this filter. Pointer to a variable that receives the latency in 100-nanosecond units. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMLatency interface reports the amount of latency that a filter introduces into the graph. Latency is defined as the time that it takes the filter to process a sample. For a source filter, latency is the filter's maximum buffer size, measured in time. For example, a video capture filter that buffers one frame at 30 frames per second introduces a latency of about 33 milliseconds. Currently, there is no support for using this interface by itself. A source filter that streams live or real-time data should implement the interface, which inherits from this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMOpenProgress.xml b/sources/Interop/Windows/Windows/um/strmif/IAMOpenProgress.xml index 9e8b79bc3a..941dccf060 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMOpenProgress.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMOpenProgress.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AbortOperation method cancels the file-open operation. Returns S_OK if successful, or an HRESULT value indicating the cause of the error. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryProgress method retrieves the progress of the file-open operation. Pointer to a variable that receives the length of the entire file, in bytes. @@ -64,7 +64,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMOpenProgress interface reports the progress of a file-open operation and enables the application to cancel the operation. Filters that open files over a network can expose this interface. An application can use it to query the progress of the download, or to cancel the download. If the network is not responsive, a method such as might block for an indefinite period. To prevent your application from blocking, create a worker thread that uses IAMOpenProgress to monitor the progress. The worker thread can cancel the operation if a predefined timeout occurs, or in response to a command from the user. The File Source (URL) filter supports this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMOverlayFX.xml b/sources/Interop/Windows/Windows/um/strmif/IAMOverlayFX.xml index dfbb4ec04e..7aebaff52d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMOverlayFX.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMOverlayFX.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetOverlayFX method retrieves the effects currently applied to the overlay surface, if any. The application can call this method while the filter graph is running. Pointer a variable that receives a value indicating which effects, if any, are currently applied to the overlay surface. The value is a logical combination of flags from the enumeration. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryOverlayFXCaps method retrieves information about which overlay effects are available to the Overlay Mixer filter. Pointer to a variable that receives a value indicating the overlay effects capabilities of the overlay surface. The value is a logical combination of flags from the enumeration. @@ -65,7 +65,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetOverlayFX method applies the specified effects to the overlay surface. Value specifying which effects to apply. The value must be a logical combination of flags from the enumeration, or the method returns E_INVALIDARG. @@ -117,7 +117,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMOverlayFX interface controls how the video overlay appears on the user's screen. The Overlay Mixer filter implements this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMPhysicalPinInfo.xml b/sources/Interop/Windows/Windows/um/strmif/IAMPhysicalPinInfo.xml index f34ecd7c9e..7e3c7da22f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMPhysicalPinInfo.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMPhysicalPinInfo.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMPhysicalPinInfo interface is deprecated.
Retrieves the type and name of the physical pin. Pointer to a variable that receives a value indicating the pin's type. The enumeration defines the pin type values. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. It will continue to be supported for backward compatibility with existing applications, but new applications and filters should not use it.
This interface enables an application or filter to retrieve information about a pin that represents a physical hardware connections. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMPluginControl.xml b/sources/Interop/Windows/Windows/um/strmif/IAMPluginControl.xml index 071749cd56..1ebbbeb8ca 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMPluginControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMPluginControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Gets a class identifier (CLSID) from the blocked list. The zero-based index of the CLSID to retrieve. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Searches the preferred list for a class identifier (CLSID) that matches a specified subtype. A media subtype GUID to match. @@ -86,7 +86,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Gets a class identifier (CLSID) from the preferred list, specified by index value. The zero-based index of the CLSID to retrieve. @@ -128,7 +128,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Queries whether a class identifier (CLSID) appears in the blocked list. The CLSID to search for. @@ -168,7 +168,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Queries whether an Audio Compression Manager (ACM) or Video Compression Manager (VCM) codec appears in the blocked list. The name of the DLL that implements the codec. @@ -208,7 +208,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Adds a class identifier (CLSID) to the blocked list, or removes a CLSID from the list. The CLSID to add or remove. @@ -217,7 +217,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Adds a class identifier (CLSID) to the preferred list or removes a CLSID from the list. A media subtype GUID to associate with the CLSID. @@ -226,7 +226,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Controls the preferred and blocked filter lists. To get a pointer to this interface, call CoCreateInstance. The class identifier (CLSID) is CLSID_DirectShowPluginControl, which is defined in the header file uuids.h. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMPushSource.xml b/sources/Interop/Windows/Windows/um/strmif/IAMPushSource.xml index f75828c3bd..8f4dbfafeb 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMPushSource.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMPushSource.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMaxStreamOffset method retrieves the maximum stream offset the filter can support. Pointer to a variable that receives a reference time indicating the maximum offset the filter can support. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetPushSourceFlags method retrieves a combination of flags describing the behavior of the filter. Pointer to a variable that receives a combination of flags from the enumeration. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetStreamOffset method retrieves the offset that the filter uses when generating time stamps. Pointer to a variable that receives a reference time indicating the current stream offset. @@ -28,7 +28,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMaxStreamOffset method specifies the stream offset that will be allowed in the filter graph. Reference time specifying the maximum stream offset. @@ -36,7 +36,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetPushSourceFlags method sets flags that specify the behavior of the filter. Currently, applications should not call this method, because request flags are not supported and an application should not override the flags set by the filter. Combination of flags from the enumeration. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetStreamOffset method sets the offset for time stamps generated by this filter. New stream offset for the filter. @@ -52,7 +52,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMPushSource interface synchronizes a filter graph that renders a live source. A live source is a source that streams data in real time, such as a capture device or a network broadcast. Source filters that stream live data should expose this interface on their output pins. Generally, applications should not call the methods on this interface; instead, use the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMResourceControl.xml b/sources/Interop/Windows/Windows/um/strmif/IAMResourceControl.xml index 6ba9e90c75..faf11f445d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMResourceControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMResourceControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reserve method reserves or unreserves a device resource. Flag indicating whether to reserve or unreserve this device. The value must be a member of the enumeration. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMResourceControl interface opens and holds an audio device resource before the device is actually needed, so that playback can be guaranteed or the application can learn in advance that a device is not available. The following filters implement this interface: diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMStreamConfig.xml b/sources/Interop/Windows/Windows/um/strmif/IAMStreamConfig.xml index ec5521b2c0..a9113c31b5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMStreamConfig.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMStreamConfig.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetFormat method retrieves the current or preferred output format. Address of a pointer to an structure. @@ -69,7 +69,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNumberOfCapabilities method retrieves the number of format capabilities that this pin supports. Pointer to a variable that receives the number of format capabilities. @@ -123,7 +123,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetFormat method sets the output format on the pin. Pointer to an structure that specifies the new format. @@ -224,7 +224,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMStreamConfig interface sets the output format on certain capture and compression filters, for both audio and video. Applications can use this interface to set format properties, such as the output dimensions and frame rate (for video) or the sample rate and number of channels (for audio). diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMStreamControl.xml b/sources/Interop/Windows/Windows/um/strmif/IAMStreamControl.xml index 9caebc2d1b..5b875ac06e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMStreamControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMStreamControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetInfo method retrieves information about the current stream-control settings, including the start and stop times. Pointer to an structure, allocated by the caller, that receives the current stream-control settings. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StartAt method informs the pin when to start delivering data. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StopAt method informs the pin when to stop delivering data. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMStreamControl interface controls individual streams on a filter. Pins on some filters expose this interface. For example, the AVI Mux Filter supports this interface on its input pins, and the Audio Capture Filter and WDM Video Capture Filter support it on their output pins. This interface enables an application to turn streams on and off at specified times. For example, an application might turn off an audio stream to mute the audio during video preview. Capture applications can use this interface to specify exact start and stop times for capture, and to control capture and preview streams independently of each other. To use this interface, call the method to specify when the pin will start delivering data, and the method to specify when it will stop delivering data. Then call on the Filter Graph Manager to run the filter graph. All times are relative to when the graph starts running. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMStreamSelect.xml b/sources/Interop/Windows/Windows/um/strmif/IAMStreamSelect.xml index a5d57d122e..10d304c5f9 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMStreamSelect.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMStreamSelect.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Count method retrieves the number of available streams. Receives the number of streams. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Enable method enables or disables a given stream. Zero-based index of the stream. @@ -141,7 +141,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Info method retrieves information about a given stream. Zero-based index of the stream. @@ -239,7 +239,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMStreamSelect interface selects from the available streams on a parser filter. For example, a file might contain audio streams encoded in several languages, such as English, German, and French. The application could use this interface to select which language is played. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMTVAudio.xml b/sources/Interop/Windows/Windows/um/strmif/IAMTVAudio.xml index ab56f120b4..459e5dc57e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMTVAudio.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMTVAudio.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAvailableTVAudioModes method retrieves a bitmask of the possible modes. Pointer to a enumeration type, identifying the audio mode. @@ -80,7 +80,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetHardwareSupportedTVAudioModes method retrieves a bitmask of the formats available in the hardware. Pointer to a enumeration value that identifies the audio mode. @@ -157,7 +157,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_TVAudioMode method retrieves the current TV audio mode. Pointer to a enumeration type, identifying the audio mode. @@ -234,7 +234,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_TVAudioMode method sets the current TV audio mode. A enumeration value that identifies the audio mode. @@ -311,7 +311,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RegisterNotificationCallBack method enables an object that implements the interface to receive event notifications when the tuner changes state. This method is not implemented. @@ -321,7 +321,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UnRegisterNotificationCallBack method unregisters an object for event notifications. This method is not implemented. @@ -330,7 +330,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMTVAudio interface controls audio from a television source. The TV Audio filter implements this interface. Applications can use it to control television audio settings, including secondary audio program (SAP) and stereo or mono selection. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMTVAudioNotification.xml b/sources/Interop/Windows/Windows/um/strmif/IAMTVAudioNotification.xml index 2598b518d8..f8111b6057 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMTVAudioNotification.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMTVAudioNotification.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMTVAudioNotification interface is deprecated.
The OnEvent method handles events from a TV tuner card controlled by the interface. Flag identifying the type of event. The only value currently defined is AMTVAUDIO_EVENT_CHANGED. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This callback interface has been deprecated, because the TV Audio filter does not implement the callback mechanism.
 diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMTVTuner.xml b/sources/Interop/Windows/Windows/um/strmif/IAMTVTuner.xml index 0978562a6e..83f3bf3627 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMTVTuner.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMTVTuner.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Channel method retrieves the channel to which the tuner is set. Pointer to a variable that receives the channel. For frequencies, see International Analog TV Tuning @@ -46,7 +46,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AutoTune method scans for a precise signal on the channel's frequency. TV channel number. @@ -55,7 +55,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_AudioFrequency method retrieves the currently tuned audio frequency. Pointer to a variable that receives the audio frequency, in hertz (Hz). @@ -63,7 +63,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_AvailableTVFormats method retrieves all the analog video TV standards that the tuner supports. Pointer to a variable that receives a bitwise combination of values from the enumeration. @@ -71,7 +71,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_ConnectInput method retrieves the hardware tuner input connection. Pointer to the input pin to get the connection for. @@ -79,7 +79,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_InputType method retrieves the input type set in . Index value that specifies the input pin that will be set. @@ -88,7 +88,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_NumInputConnections method retrieves the number of TV sources plugged into the tuner filter. Pointer to a variable that receives the number of TV sources plugged into the tuner filter. @@ -96,7 +96,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_TVFormat method retrieves the current analog video TV standard in use. Pointer to a variable that receives a member of the enumeration. @@ -104,7 +104,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_VideoFrequency method retrieves the current video frequency. Pointer to a variable that receives the video frequency, in hertz (Hz). @@ -112,7 +112,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_ConnectInput method sets the hardware tuner input connection. Index value of the input pin to set connection for. @@ -120,7 +120,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_InputType method sets the tuner input type (cable or antenna). Index value that specifies the input pin to be set. @@ -129,14 +129,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StoreAutoTune method saves the fine-tuning information for all channels. Returns an HRESULT value that depends on the implementation of the interface. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMTVTuner interface controls a TV tuner. The TV Tuner filter implements this interface. Applications can use this interface to set TV channels and to get or set information about their frequencies, and to determine what analog video standards your TV tuner card supports. The interface supports tuners for analog broadcast television and AM/FM radio. It supports tuners with multiple input pins, to enable multiple devices and multiple transmission types. The TV Tuner filter supports worldwide tuning coverage. It maps TV channels to specific frequencies through the and methods. These methods handle the details of the conversion, so that the hardware driver receives an exact frequency. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeDisplay.xml b/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeDisplay.xml index 5b22c0ae1c..87471aea83 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeDisplay.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeDisplay.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTCDisplay method retrieves current settings of the timecode character generator output. @@ -65,7 +65,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTCDisplayEnable method determines whether an external device's timecode character generator output is enabled or disabled. Pointer to a value indicating whether timecode character generator output is enabled. OATRUE indicates enabled; OAFALSE indicates disabled. @@ -73,7 +73,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTCDisplay method sets the timecode character generator output characteristics. @@ -134,7 +134,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTCDisplayEnable method enables or disables an external device's timecode character output generator. Value specifying whether to enable or disable the timecode character output generator. Specify OATRUE to enable or OAFALSE to disable. @@ -142,7 +142,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMTimecodeDisplay interface controls an external SMPTE/MIDI timecode display device. DirectShow currently does not provide any filters that implement this interface. Third parties should implement this interface on any filter that controls the timecode display of an external timecode reader or generator. Timecode readers or generators can be built into a VCR or can be separate external devices. This interface is not intended for rendering in a DirectShow filter graph; it is purely for use on external device displays. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeGenerator.xml b/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeGenerator.xml index 850ea6e893..78dbfebcca 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeGenerator.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeGenerator.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTCGMode method retrieves the SMPTE timecode generator properties. @@ -61,7 +61,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTimecode method retrieves the most recent timecode and/or userbit value available in the stream. Pointer to a structure. @@ -69,7 +69,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_VITCLine method retrieves which line(s) the vertical interval timecode information has been inserted into. Pointer to the vertical line(s) containing the timecode information (valid lines are 11-20). @@ -77,7 +77,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_VITCLine method specifies which line to insert the vertical interval timecode information into. Vertical line to contain the timecode information (valid lines are 11-20; 0 means autoselect). @@ -85,7 +85,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTCGMode method sets the SMPTE timecode generator properties. @@ -142,7 +142,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTimecode method sets the timecode, userbit value, or both. Pointer to a structure. @@ -150,7 +150,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMTimecodeGenerator interface controls how an external SMPTE/MIDI timecode generator supplies data to the filter graph. DirectShow currently does not provide any filters that implement this interface. Third parties should implement this interface on any filter that controls an external timecode generator. Timecode generators can be built into a VCR or can be separate external devices. The device must be able to read timecode and send it to the computer over its control interface. If not, the user must have a timecode reader card in the computer, or you can write a software decoder that converts VITC embedded in captured video frames or LTC captured as an audio signal into DirectShow timecode samples. SMPTE timecode is a frame addressing system that identifies video and audio sources, makes automatic track synchronization possible, and provides a container for additional data related to the production. SMPTE timecode's main purpose is to provide a machine-readable address for video and audio. It is displayed in hh:mm:ss:ff format and is thoroughly defined in ANSI/SMPTE 12-1986. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeReader.xml b/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeReader.xml index daed416cf0..3f8d795987 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeReader.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMTimecodeReader.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTCRMode method retrieves the timecode reader's properties. This method is not implemented. @@ -38,7 +38,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTimecode method retrieves the most recent timecode, userbit, and flag values available in the stream. Pointer to a structure. @@ -46,7 +46,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_VITCLine method retrieves the vertical interval line that the timecode reader is using to read timecode. This method is not implemented. @@ -55,7 +55,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_VITCLine method specifies the vertical interval line that the timecode reader will use to read timecode. This method is not implemented. @@ -64,7 +64,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTCRMode method sets the timecode reader properties. This method is not implemented. @@ -98,7 +98,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMTimecodeReader interface reads SMPTE or MIDI timecode from an external device. The MSDV and MSTape drivers support this interface for reading timecode from an external DV or MPEG-2 camcorder. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMTuner.xml b/sources/Interop/Windows/Windows/um/strmif/IAMTuner.xml index 28e6bef935..b07613c1ed 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMTuner.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMTuner.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ChannelMinMax method retrieves the highest and lowest channels available. Pointer to a variable that receives the lowest channel. @@ -46,7 +46,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAvailableModes method retrieves the tuner's supported modes. Pointer to a variable that receives any combination of the values as specified in the enumeration. @@ -54,7 +54,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Channel method retrieves the channel to which the tuner is set. Pointer to a variable that receives the channel. For frequencies, see International Analog TV Tuning @@ -96,7 +96,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_CountryCode method retrieves the country/region code that establishes the current channel-to-frequency mapping. Pointer to a variable that receives the country/region code currently in use by the TV Tuner filter. @@ -104,7 +104,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Mode method retrieves the current mode on a multifunction tuner. Pointer to a variable that receives a flag indicating the current mode setting. The possible values are defined in the enumeration. @@ -112,7 +112,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_TuningSpace method retrieves the tuning space. Pointer to a variable that receives the current tuning space. @@ -120,7 +120,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Logon method logs a user onto the system. Handle to an application-defined data structure that identifies the current user. @@ -128,14 +128,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Logout method logs out the current user. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Channel method sets the TV channel. TV channel number. @@ -145,7 +145,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_CountryCode method sets the country/region code to establish the frequency to use. Value indicating the country/region code. @@ -153,7 +153,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Mode method sets a multifunction tuner to the specified mode. @@ -164,7 +164,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_TuningSpace method sets a storage index for regional channel-to-frequency mappings. Value indicating the current locale. @@ -172,7 +172,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RegisterNotificationCallBack method enables an object to receive event notifications when the tuner changes state. This method is not implemented. @@ -182,7 +182,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SignalPresent method retrieves the strength of the signal on a given channel. @@ -209,7 +209,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UnRegisterNotificationCallBack method unregisters an object for event notifications. This method is not implemented. @@ -218,7 +218,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMTuner interface controls a TV tuner. This interface is the base class for the interface, which inherits all of the IAMTuner methods. For more information on controlling a TV tuner using Microsoft DirectShow, see the IAMTVTuner documentation. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMTunerNotification.xml b/sources/Interop/Windows/Windows/um/strmif/IAMTunerNotification.xml index 506f06b9a7..0671aaab22 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMTunerNotification.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMTunerNotification.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMTunerNotification interface is deprecated.
The OnEvent method handles events from the TV tuner card. Flag identifying the type of event. Currently, the only value defined is AMTUNER_EVENT_CHANGED. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This callback interface has been deprecated, because the TV Tuner filter does not implement the callback mechanism.
 diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMVfwCaptureDialogs.xml b/sources/Interop/Windows/Windows/um/strmif/IAMVfwCaptureDialogs.xml index b3530e36f5..9a076d835a 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMVfwCaptureDialogs.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMVfwCaptureDialogs.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The HasDialog method determines if the specified dialog box exists in the driver. Desired dialog box. This is a member of the enumeration. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SendDriverMessage method sends a driver-specific message. Handle of the driver dialog box. This is a member of the enumeration. @@ -23,7 +23,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ShowDialog method displays the specified VFW dialog box. Dialog box to display. This is a member of the enumeration. @@ -88,7 +88,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMVfwCaptureDialogs interface displays a dialog box provided by a Video for Windows (VFW) capture driver. The VFW Capture filter implements this interface. Applications can use it to display one of the three dialog boxes (Source, Format, or Display) provided by VFW capture drivers. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMVfwCompressDialogs.xml b/sources/Interop/Windows/Windows/um/strmif/IAMVfwCompressDialogs.xml index c11b5e307d..bff54257e9 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMVfwCompressDialogs.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMVfwCompressDialogs.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetState method retrieves the current configuration settings for the VCM codec currently being used. State of the VCM codec. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SendDriverMessage method sends a driver-specific message. Message to send to the driver. @@ -23,7 +23,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetState method sets configuration for the VCM codec. State of the VCM codec. @@ -32,7 +32,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ShowDialog method displays the specified dialog box. Dialog box to display. This is a member of the enumeration. @@ -41,7 +41,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMVfwCompressDialogs interface displays a dialog box provided by a Video for Windows (VFW) codec. The AVI Compressor filter implements this interface. Applications can use it to display one of the dialog boxes (Configure or About) provided by VFW codecs, and to set and retrieve compressor status. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMVideoCompression.xml b/sources/Interop/Windows/Windows/um/strmif/IAMVideoCompression.xml index 5165ae5bf0..1ba36b4d18 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMVideoCompression.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMVideoCompression.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetInfo method retrieves information about the filter's compression properties, including capabilities and default values. Pointer to a buffer that receives a version string, such as "Version 2.1.0." @@ -19,7 +19,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_KeyFrameRate method retrieves the current key-frame rate. Pointer to a variable that receives the current key-frame rate. If the value is negative, the filter will use the default key-frame rate. If the value is zero, only the first frame is a key frame. @@ -27,7 +27,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_PFramesPerKeyFrame method retrieves the rate of predicted (P) frames per key frame. Pointer to a variable that receives the number of P frames per key frame. If the value is negative, the filter will use the default rate. @@ -35,7 +35,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Quality method retrieves the current compression quality. Pointer to a variable that receives the relative compression quality. The quality is expressed as a value between 0.0 and 1.0, where 1.0 indicates the best quality and 0.0 indicates the worst quality. If the value is negative, the filter will use the default quality. @@ -43,7 +43,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_WindowSize method retrieves the number of frames over which the compressor will maintain the average data rate. For example, assuming a data rate of 100K/sec and a frame rate of 10 frames per second, if the window size is 1, then every frame will be 10K or less. If the window size is 5, then every five consecutive frames will average 10K per frame, but individual frames may exceed this size. The default window size is 1. @@ -98,7 +98,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OverrideFrameSize method overrides the frame size of a specified frame. Specifies the frame number. The first frame that the filter delivers is numbered zero. @@ -139,7 +139,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OverrideKeyFrame method instructs the filter to compress a particular frame as a key frame. Specifies the frame number. The first frame that the filter delivers is numbered zero. @@ -179,7 +179,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_KeyFrameRate method sets the key-frame rate. Desired key-frame rate. If the value is negative, the filter will use the default key-frame rate. If the value is zero, only the first frame will be a key frame. @@ -187,7 +187,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_PFramesPerKeyFrame method sets the rate of predicted (P) frames per key frame. Specifies the number of P frames per key frame. If the value is negative, the filter will use the default rate. @@ -195,7 +195,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Quality method sets the compression quality. Specifies the quality as a value between 0.0 and 1.0, where 1.0 indicates the best quality and 0.0 indicates the worst quality. If the value is negative, the filter will use the default quality. @@ -203,7 +203,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_WindowSize method sets the number of frames over which the compressor must maintain an average data rate. For example, assuming a data rate of 100K/sec and a frame rate of 10 frames per second, if the window size is 1, then every frame will be 10K or less. If the window size is 5, then every five consecutive frames must average 10K per frame, but individual frames may exceed this size. @@ -212,7 +212,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMVideoCompression interface sets and retrieves video compression properties. It is supported by some video compression filters, and also by some video capture filters that output compressed video. Filters that support this interface expose it through their output pins. An application can use this interface to control how video is compressed, including characteristics such as the key-frame rate or the compression quality. A filter that supports this interface might not support every method. Use the method to determine which methods the filter supports. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMVideoControl.xml b/sources/Interop/Windows/Windows/um/strmif/IAMVideoControl.xml index 35f95f9258..48c7ffbe95 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMVideoControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMVideoControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCaps method retrieves the capabilities of the underlying hardware. Pointer to the pin to query capabilities from. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentActualFrameRate method retrieves the actual frame rate, expressed as a frame duration in 100-nanosecond units. USB (Universal Serial Bus) and IEEE 1394 cameras may provide lower frame rates than requested because of bandwidth availability. This is only available during video streaming. Pointer to the pin to retrieve the frame rate from. @@ -22,7 +22,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetFrameRateList method retrieves a list of available frame rates. Pointer to the pin to query for the list of frame rates. @@ -34,7 +34,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMaxAvailableFrameRate method retrieves the maximum frame rate currently available, based on bus bandwidth usage for connections, such as USB and IEEE 1394, where the maximum frame rate may be limited by bandwidth availability. Pointer to the pin to retrieve the maximum frame rate from. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMode method retrieves the video control mode of operation. Pointer to the pin to retrieve the video control mode from. @@ -54,7 +54,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMode method sets the video control mode of operation. Pointer to the pin to set the video control mode on. @@ -63,7 +63,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMVideoControl interface controls certain video capture operations such as enumerating available frame rates and image orientation. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMVideoDecimationProperties.xml b/sources/Interop/Windows/Windows/um/strmif/IAMVideoDecimationProperties.xml index f95f6a4934..363e8d5606 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMVideoDecimationProperties.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMVideoDecimationProperties.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryDecimationUsage method retrieves the current decimation strategy. Pointer to a variable of type that receives the decimation setting. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDecimationUsage method sets the decimation strategy. Member of the enumeration that specifies the decimation strategy. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMVideoDecimationProperties interface controls how the Overlay Mixer performs video decimation If a video window is smaller than the native size of the video being displayed, the video renderer must decimate the incoming video—that is, scale the video down to the smaller size. Decimation can be performed in one of the following places. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMVideoProcAmp.xml b/sources/Interop/Windows/Windows/um/strmif/IAMVideoProcAmp.xml index 78797455da..f3cbf1de5c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMVideoProcAmp.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMVideoProcAmp.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Get method gets the current setting of a video property. Specifies the property to retrieve, as a value from the enumeration. @@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetRange method gets the range and default value of a specified video property. Specifies the property to query, as a value from the enumeration. @@ -84,7 +84,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Set method sets video quality for a specified property. The property to set, specified as a enumeration value. @@ -94,7 +94,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAMVideoProcAmp interface adjusts the qualities of an incoming video signal, such as brightness, contrast, hue, saturation, gamma, and sharpness. The WDM Video Capture filter exposes this interface if the hardware supports image adjustment. diff --git a/sources/Interop/Windows/Windows/um/strmif/IAMovieSetup.xml b/sources/Interop/Windows/Windows/um/strmif/IAMovieSetup.xml index 188e578c56..77b8e8689a 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAMovieSetup.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAMovieSetup.xml @@ -4,21 +4,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMovieSetup interface is deprecated. Use the AMovieDllRegisterServer2 function instead.
Adds the filter to the registry. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IAMovieSetup interface is deprecated. Use the AMovieDllRegisterServer2 function instead.
Removes the filter from the registry. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. It is used by two obsolete functions, AMovieDllRegisterServer and AMovieDllUnregisterServer. These functions are now replaced by AMovieDllRegisterServer2, which does not require IAMovieSetup. However, IAMovieSetup will continue to be supported for backward compatibility with existing applications.
 diff --git a/sources/Interop/Windows/Windows/um/strmif/IAsyncReader.xml b/sources/Interop/Windows/Windows/um/strmif/IAsyncReader.xml index fe4e8bc97e..b47fefa841 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IAsyncReader.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IAsyncReader.xml @@ -4,21 +4,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The BeginFlush method begins a flush operation. Returns S_OK if successful, or S_FALSE otherwise. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EndFlush method ends a flush operation. Returns S_OK if successful, or S_FALSE otherwise. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Length method retrieves the total length of the stream. Pointer to a variable that receives the length of the stream, in bytes. @@ -71,7 +71,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Request method queues an asynchronous request for data. Pointer to the interface of a media sample provided by the caller. @@ -160,7 +160,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RequestAllocator method requests an allocator during the pin connection. Pointer to the interface on the input pin's preferred allocator, or NULL. @@ -214,7 +214,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SyncRead method performs a synchronous read. The method blocks until the request is completed. The file positions and the buffer address do not have to be aligned. If the request is not aligned, the method performs a buffered read operation. Specifies the byte offset at which to begin reading. The method fails if this value is beyond the end of the file. @@ -256,7 +256,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SyncReadAligned method performs a synchronous read. The method blocks until the request is completed. The file positions and the buffer address must be aligned; check the allocator properties for the required alignment. Pointer to the interface of a media sample provided by the caller. @@ -308,7 +308,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The WaitForNext method waits for the next pending read request to complete. Specifies a time-out in milliseconds. Use the value INFINITE to wait indefinitely @@ -386,7 +386,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IAsyncReader interface performs an asynchronous data request on a filter. This interface is exposed by output pins that perform asynchronous read operations. The interface is used by the input pin on the downstream filter. Applications do not use this interface. The Async File Source filter exposes this interface on its output pin. diff --git a/sources/Interop/Windows/Windows/um/strmif/IBPCSatelliteTuner.xml b/sources/Interop/Windows/Windows/um/strmif/IBPCSatelliteTuner.xml index 54d52b16d4..a72698b394 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IBPCSatelliteTuner.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IBPCSatelliteTuner.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IBPCSatelliteTuner interface is deprecated.
Gets the default sub-channel types. Receives a provider-specific service type for video. @@ -13,14 +13,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IBPCSatelliteTuner interface is deprecated.
Queries whether taping is permitted. Returns S_OK if taping is permitted or S_FALSE if taping is not permitted. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IBPCSatelliteTuner interface is deprecated.
Sets the default sub-channel types. Provider-specific service type for video. @@ -29,7 +29,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface is not implemented and has been deprecated.
The IBPCSatelliteTuner interface supports satellite television tuning. diff --git a/sources/Interop/Windows/Windows/um/strmif/IBaseFilter.xml b/sources/Interop/Windows/Windows/um/strmif/IBaseFilter.xml index afac1ecaa7..7521963c37 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IBaseFilter.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IBaseFilter.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EnumPins method enumerates the pins on this filter. Address of a variable that receives a pointer to the interface. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FindPin method retrieves the pin with the specified identifier. Pointer to a constant wide-character string that identifies the pin. Call the method to retrieve a pin's identifier. @@ -111,7 +111,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The JoinFilterGraph method notifies the filter that it has joined or left the filter graph. Pointer to the Filter Graph Manager's interface, or NULL if the filter is leaving the graph. @@ -120,7 +120,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryFilterInfo method retrieves information about the filter. Pointer to a structure. @@ -161,7 +161,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryVendorInfo method retrieves a string containing vendor information. Address of a variable that receives a pointer to a wide-character string containing the vendor information. @@ -214,7 +214,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetState method retrieves the filter's state (running, stopped, or paused). Time-out interval, in milliseconds. To block indefinitely, use the value INFINITE. @@ -280,7 +280,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Pause method pauses the filter. @@ -319,7 +319,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IBaseFilter interface is the primary interface for DirectShow filters. All DirectShow filters must expose this interface. The Filter Graph Manager uses this interface to control filters. Applications can use this interface to enumerate pins and query for filter information, but should not use it to change the state of a filter. Instead, use the interface on the Filter Graph Manager. Filter developers: Implement this interface on every DirectShow filter. The CBaseFilter base class implements this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/ICaptureGraphBuilder.xml b/sources/Interop/Windows/Windows/um/strmif/ICaptureGraphBuilder.xml index 1d3bb59967..4f6ededae6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/ICaptureGraphBuilder.xml +++ b/sources/Interop/Windows/Windows/um/strmif/ICaptureGraphBuilder.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The ICaptureGraphBuilder interface is deprecated. Use instead.
Preallocates a capture file to a specified size. Pointer to a wide-character string containing the name of the file to create or resize. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The ICaptureGraphBuilder interface is deprecated. Use instead.
Sends stream control messages to the pin of the specified category on one or more capture filters in a graph. Pointer to a GUID specifying the output pin category. See Pin Property Set for a list of all pin categories. This value cannot be NULL. @@ -30,7 +30,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The ICaptureGraphBuilder interface is deprecated. Use instead.
Copies the valid media data from the preallocated capture file. Pointer to a Unicode™ string containing the source file name. @@ -41,7 +41,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The ICaptureGraphBuilder interface is deprecated. Use instead.
Looks for the specified interface on the filter, upstream and downstream from the filter, and, optionally, only on the output pin of the given category. Pointer to a GUID specifying the output pin category. See Pin Property Set for a list of all pin categories. NULL indicates search all the output pins regardless of category. @@ -52,7 +52,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The ICaptureGraphBuilder interface is deprecated. Use instead.
Retrieves the filter graph that the builder is using. Address of a pointer to an interface. @@ -60,7 +60,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The ICaptureGraphBuilder interface is deprecated. Use instead.
Connects a source filter's pin, of an optionally specified category, to the rendering filter, and optionally through another filter. Pointer to a GUID specifying which output pin of the source filter to connect. See Pin Property Set for a list of all pin categories. NULL indicates render the only output pin, regardless of category. @@ -71,7 +71,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The ICaptureGraphBuilder interface is deprecated. Use instead.
Tells the graph builder object which filter graph to use. Pointer to an interface that specifies the filter graph to use for subsequent calls to the method. @@ -79,7 +79,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The ICaptureGraphBuilder interface is deprecated. Use instead.
Creates the rendering section of the filter graph, which will save bits to disk with the specified file name. Pointer to a GUID representing the media subtype. Must be &MEDIASUBTYPE_Avi. @@ -183,7 +183,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. It will continue to be supported for backward compatibility with existing applications, but new applications should use the interface.
The ICaptureGraphBuilder interface enables you to build capture graphs, preview graphs, file recompression graphs, or other custom graphs. diff --git a/sources/Interop/Windows/Windows/um/strmif/ICaptureGraphBuilder2.xml b/sources/Interop/Windows/Windows/um/strmif/ICaptureGraphBuilder2.xml index 97447cb9e8..bb6624c816 100644 --- a/sources/Interop/Windows/Windows/um/strmif/ICaptureGraphBuilder2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/ICaptureGraphBuilder2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AllocCapFile method preallocates a capture file to a specified size. For best results, always capture to a defragmented, preallocated capture file that is larger than the size of the capture data. Pointer to a wide-character string that contains the name of the file to create or resize. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CopyCaptureFile method copies the valid media data from a capture file. Pointer to a wide-character string that contains the source file name. @@ -105,7 +105,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FindInterface method searches the graph for a specified interface, starting from a specified filter. You can restrict the search to a section of the graph upstream or downstream of the filter, or restrict it to a particular pin category or media type. @@ -191,7 +191,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FindPin method retrieves a particular pin on a filter, or determines whether a given pin matches the specified criteria. Pointer to an interface on a filter, or to an interface on a pin. @@ -205,7 +205,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetFiltergraph method retrieves the filter graph that the capture graph builder is using. Receives an interface pointer. @@ -258,7 +258,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RenderStream method connects an output pin on a source filter to a sink filter, optionally through an intermediate filter. @@ -364,7 +364,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetFiltergraph method specifies a filter graph for the capture graph builder to use. Pointer to the filter graph's interface. @@ -417,7 +417,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetOutputFileName method creates the file writing section of the filter graph. @@ -489,7 +489,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ICaptureGraphBuilder2 interface builds capture graphs and other custom filter graphs. The Capture Graph Builder object implements this interface.
Note  By default, the ICaptureGraphBuilder2 interface does not use the Video Mixing Renderer (VMR), Enhanced Video Renderer (EVR) or Video Port Manager filters.
diff --git a/sources/Interop/Windows/Windows/um/strmif/ICodecAPI.xml b/sources/Interop/Windows/Windows/um/strmif/ICodecAPI.xml index 6a05bff80e..57900453d6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/ICodecAPI.xml +++ b/sources/Interop/Windows/Windows/um/strmif/ICodecAPI.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAllSettings method gets the codec's current properties and writes them to a stream. Pointer to the IStream interface of the stream. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDefaultValue method gets the default value of a codec property. Pointer to a GUID that specifies the property. For a list of standard codec properties, see Codec API Properties. @@ -85,7 +85,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetParameterRange method gets the range of values for a codec property. This method applies only to properties whose values form a linear range. @@ -144,7 +144,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetParameterValues method gets the list of possible values for a codec property. This method applies only to properties that support a list of possible values, as opposed to a linear range. @@ -199,7 +199,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetValue method gets the current value of a codec property. Pointer to a GUID that specifies the property. For a list of standard codec properties, see Codec API Properties. @@ -240,7 +240,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsModifiable method queries whether a codec property can be changed, given the codec's current configuration. Pointer to a GUID that specifies the property. For a list of standard codec properties, see Codec API Properties. @@ -280,7 +280,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsSupported method queries whether a codec supports a given property. Pointer to a GUID that specifies the property to query. For a list of standard codec properties, see Codec API Properties. @@ -332,7 +332,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RegisterForEvent method registers the application to receive events from the codec. @@ -417,14 +417,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetAllDefaults method resets all codec properties to their default values. If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetAllDefaultsWithNotify method resets all codec properties to their default values, and returns a list of the properties that changed. Receives a pointer to an array of GUIDs. The array contains the GUIDs of any properties that changed as a result of this method call. The caller must free the array by calling CoTaskMemFree. @@ -465,7 +465,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetAllSettings method reads codec properties from a stream and sets them on the codec. Pointer to the IStream interface of the stream. @@ -505,7 +505,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetAllSettingsWithNotify method reads codec properties from a stream, sets them on the codec, and returns a list of the properties that changed. Pointer to the IStream interface of the stream. @@ -547,7 +547,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetValue method sets the value of a codec property. Pointer to a GUID that specifies the property to set. For a list of standard codec properties, see Codec API Properties. @@ -600,7 +600,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetValueWithNotify method sets a property on a codec and returns a list of other properties that changed as a result. Pointer to a GUID that specifies the property to set. For a list of standard codec properties, see Codec API Properties. @@ -643,7 +643,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UnregisterForEvent method unregisters the application for a specified encoder event. Pointer to a GUID that specifies the event. @@ -651,7 +651,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ICodecAPI interface sets and retrieves settings on an encoder or decoder filter.
[!Note] APIs declared in strmif.h are not supported for Universal Windows Platform (UWP) apps. To use ICodecAPI in a UWP app, use the version declared in .
 diff --git a/sources/Interop/Windows/Windows/um/strmif/IConfigAviMux.xml b/sources/Interop/Windows/Windows/um/strmif/IConfigAviMux.xml index ac0d47f476..437ccc965c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IConfigAviMux.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IConfigAviMux.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMasterStream method queries which stream will be used to synchronize the other streams in the file. Receives the index of the master stream, or -1 if no master stream was set. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetOutputCompatibilityIndex method retrieves the setting for the AVI index format. @@ -106,7 +106,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMasterStream method specifies a stream that will be used to synchronize the other streams in the file. Specifies the index of the stream, or –1 to indicate no master stream. The AVI Mux writes one stream for each connected input pin. Stream numbers are indexed from zero. @@ -146,7 +146,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetOutputCompatibilityIndex method sets the AVI index format. @@ -174,7 +174,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IConfigAviMux interface configures the AVI Mux filter. Applications can use this interface to set the master stream and to create an AVI 1.0 index. methods. diff --git a/sources/Interop/Windows/Windows/um/strmif/IConfigInterleaving.xml b/sources/Interop/Windows/Windows/um/strmif/IConfigInterleaving.xml index bfbe6ae623..38976932f7 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IConfigInterleaving.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IConfigInterleaving.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Interleaving method gets the audio preroll time and the frequency of interleaving for an AVI file. Receives the approximate duration of each interleaved group of audio or video chunks. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_Mode method retrieves the interleaving quality setting. Receives the interleaving quality, specified as a member of the enumeration. @@ -21,7 +21,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Interleaving method sets the audio preroll time and the frequency of interleaving for an AVI file. The approximate duration of each interleaved group of audio or video chunks, in 100-nanosecond units. The exact amount of interleaving is also affected by the interleave mode, which is specified by calling . @@ -30,7 +30,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_Mode method sets how audio samples and video frames are to be written to disk, by specifying quality of interleaving. Interleaving quality setting specified in the enumeration. @@ -38,7 +38,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IConfigInterleaving interface controls how the AVI Mux filter interleaves audio and video samples. Video-authoring applications that handle capturing should use this interface when they need to control how audio samples and video frames will be saved on a disk. diff --git a/sources/Interop/Windows/Windows/um/strmif/ICreateDevEnum.xml b/sources/Interop/Windows/Windows/um/strmif/ICreateDevEnum.xml index ea61ec66e4..8678b48680 100644 --- a/sources/Interop/Windows/Windows/um/strmif/ICreateDevEnum.xml +++ b/sources/Interop/Windows/Windows/um/strmif/ICreateDevEnum.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CreateClassEnumerator method creates an enumerator for a specified device category. Specifies the class identifier (CLSID) of the device category. See Filter Categories. @@ -95,7 +95,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ICreateDevEnum interface creates an enumerator for a category of filters, such as video capture devices or audio capture devices. The System Device Enumerator exposes this interface. Applications can use this interface to enumerate filters within a category. The method returns an enumerator object for a specific filter category. The enumerator object supports the interface and returns a list of monikers, where each moniker represents a filter. In some cases, the same DirectShow filter manages an entire category of hardware devices. In that case, the moniker represents the device, and the moniker is used to initialize the filter. The application can treat each device as a separate filter, regardless of the underlying implementation. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDDrawExclModeVideo.xml b/sources/Interop/Windows/Windows/um/strmif/IDDrawExclModeVideo.xml index 6064ed898e..0a83ebe924 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDDrawExclModeVideo.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDDrawExclModeVideo.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDDrawObject method retrieves the DirectDraw object being used by the Overlay Mixer filter. Address of a pointer to the IDirectDraw interface that the Overlay Mixer is using. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDDrawSurface method retrieves the DirectDraw surface being used by the Overlay Mixer. Address of a pointer to the IDirectDrawSurface interface that is being used by the Overlay Mixer. @@ -110,7 +110,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNativeVideoProps method retrieves the current video size and picture aspect ratio of the Overlay Mixer's primary stream. Address of variable that receives the width of the video. @@ -153,7 +153,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetCallbackInterface method retrieves a pointer to the callback interface of the Overlay Mixer so that the calling application can be notified about adjustments to the display during video playback. Pointer to the object that implements the interface. If pCallback is NULL, the callback interface is set to NULL and no more callbacks are made. If there was a previous callback interface, it is released and no more callbacks are made to it. If pCallback is not NULL and this method returns S_OK, then the reference count of the object pCallback points to is incremented. @@ -194,7 +194,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDDrawObject method sets the DirectDraw object to be used in subsequent drawing. Pointer to the IDirectDraw interface on the object to use. @@ -246,7 +246,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDDrawSurface method specifies the DirectDraw surface to be used in subsequent drawing. Pointer to the IDirectDrawSurface interface on the surface to use. @@ -293,7 +293,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDrawParameters method specifies which part of the original video will appear at which position of the screen. Pointer to the RECT structure of the original video. @@ -302,7 +302,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDDrawExclModeVideo interface enables video playback in DirectDraw exclusive full-screen mode. The Overlay Mixer Filter implements this interface. Game applications can use DirectDraw in exclusive full-screen mode and continue playing video. For example, the video can be in the background and graphics can be used on top of it. The application passes in a DirectDraw object and primary surface, and these are passed to the Overlay Mixer filter in the filter graph. The DVD graph builder object uses IDDrawExclModeVideo to play DVD content while in DirectDraw exclusive full-screen mode. This interface can also be used alone to play MPEG-1 or AVI videos in games. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDDrawExclModeVideoCallback.xml b/sources/Interop/Windows/Windows/um/strmif/IDDrawExclModeVideoCallback.xml index 66eccad568..33a071a882 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDDrawExclModeVideoCallback.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDDrawExclModeVideoCallback.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OnUpdateColorKey method informs the application that the color key has changed so that the application can use the new color key to overlay graphics on the video. Pointer to a structure that contains the key type and a palette index. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OnUpdateOverlay method informs the application when the overlay surface for the video is about to become visible, invisible, change size, or change position, so that the application can repaint its window appropriately. Boolean value specifying whether the call is being made before or after the overlay-related change. TRUE specifies before, FALSE specifies after. @@ -92,7 +92,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OnUpdateSize method informs the application that the size of the video rectangle is about to change. The new width, in pixels, of the video stream. @@ -103,7 +103,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDDrawExclModeVideoCallback interface is a callback interface for the interface. This callback interface enables applications to get synchronous notification about changes to the overlay position, size, visibility, and so on, so that the application can adjust its video visibility, size, and position. This avoids any color key flash at the beginning, end, or during playback. The application must implement the interface. It is important that none of the methods block or slow down the video processing, because this will cause problems with playback. Use this interface if you are writing a filter that supports IDDrawExclModeVideo or needs to generate callbacks to enable an application to draw color keys at the right time. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDVEnc.xml b/sources/Interop/Windows/Windows/um/strmif/IDVEnc.xml index bdbbc4db12..48db48545f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDVEnc.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDVEnc.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_IFormatResolution method retrieves the encoding resolution. Pointer to a variable that receives a member of the enumeration, specifying the video standard in use (NTSC or PAL). @@ -16,7 +16,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_IFormatResolution method sets the encoding resolution. Member of the enumeration, specifying the video standard to use (NTSC or PAL). @@ -28,7 +28,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDVEnc interface sets and retrieves properties on the DV Video Encoder filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDVRGB219.xml b/sources/Interop/Windows/Windows/um/strmif/IDVRGB219.xml index 437a4bbe94..aef3f34a83 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDVRGB219.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDVRGB219.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetRGB219 method controls the dynamic range for DV encoding and decoding. The DV video format has a dynamic range of 16–235. By default, when the DV Video Decoder decodes to 24-bit or 32-bit RGB, it stretches the color range to 0–255. Similarly, the DV Video Encoder compresses 24-bit RGB into the 16-235 range. In RGB-219 mode, the decoder does not stretch the color range, and the encoder does not compress the color range. Use the SetRGB219 method to toggle between the default mode and RGB-219 mode. @@ -33,7 +33,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDVRGB219 interface controls the dynamic range in the DV Video Encoder and DV Video Decoder filters. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDVSplitter.xml b/sources/Interop/Windows/Windows/um/strmif/IDVSplitter.xml index 7aa9e71896..f43d5bfe4b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDVSplitter.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDVSplitter.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DiscardAlternateVideoFrames method discards half of the frames in the video stream. For NTSC, the frame rate is reduced from 30 frames per second (fps) to 15 fps. For PAL, the frame rate is reduced from 25 fps to 12.5 fps. Flag that specifies whether to discard frames. If the value is non-zero, the filter discards alternate frames. If the value is zero, the filter delivers every frame. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Downgrades the frame rate on a digital video (DV) stream. The DV Splitter filter exposes this interface. Applications can use this interface to reduce the frame rate on a DV stream, before the stream reaches the DV Video Decoder filter. This can be helpful for processor-intensive tasks, such as real-time transcoding. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDecimateVideoImage.xml b/sources/Interop/Windows/Windows/um/strmif/IDecimateVideoImage.xml index aa1680cda4..408d8e7324 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDecimateVideoImage.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDecimateVideoImage.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ResetDecimationImageSize method specifies that the decoder should no longer decimate its output image. Returns an HRESULT value indicating the success or failure of the call. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDecimationImageSize method specifies the dimensions to which the decoder should decimate its output image. Specifies the width of the video image, in pixels. @@ -52,7 +52,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDecimateVideoImage interface specifies decimation on a decoder filter. The term decimation refers to scaling the video output down to a size smaller than the native size of the video. Applications must not call methods on this interface. The Overlay Mixer filter uses this interface to decimate video at the video decoder. Decoder filters that can decimate their video output should support this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDistributorNotify.xml b/sources/Interop/Windows/Windows/um/strmif/IDistributorNotify.xml index 3b3f8e8b71..fd5b0ad95b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDistributorNotify.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDistributorNotify.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NotifyGraphChange method is called when the set of filters in the filter graph changes or any pin connections change. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Pause method is called when the filter graph is entering a paused state. @@ -50,7 +50,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Run method is called when the filter graph is entering a running state. Stream-time offset that will be passed to every filter's method. @@ -58,7 +58,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetSyncSource method is called when a new clock is registered. Pointer to the new clock's interface. @@ -66,7 +66,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Stop method is called when the filter graph is entering a stopped state. @@ -105,7 +105,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDistributorNotify interface enables a plug-in distributor to be notified when the filter graph changes. Applications never use this interface. Implement this interface if you are writing a plug-in distributor (PID) and want the PID to receive notifications of control and changes in the composition of filter graphs. The Filter Graph Manager queries for this interface on any plug-in distributors that it aggregates. If a PID exposes this interface, the Filter Graph Manager notifies the PID of any state changes by calling IDistributorNotify methods before calling the equivalent methods on the filters. The Filter Graph Manager also calls the method whenever it adds or removes a filter, or any pin connections change. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDrawVideoImage.xml b/sources/Interop/Windows/Windows/um/strmif/IDrawVideoImage.xml index 9a17cee2f7..a6cde00489 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDrawVideoImage.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDrawVideoImage.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. New applications should not use it.
The DrawVideoImageBegin method turns off DirectDraw in preparation for a call to the DrawVideoImageDraw method. @@ -31,7 +31,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. New applications should not use it.
The DrawVideoImageDraw method draws the specified source rectangle to the specified destination rectangle in the specified GDI device context. Specifies the device context. @@ -61,7 +61,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. New applications should not use it.
The DrawVideoImageEnd method turns DirectDraw back on after drawing has been performed. @@ -88,7 +88,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. New applications should not use it.
The IDrawVideoImage interface enables an application to draw the same video image in multiple places simultaneously on the screen. The Video Renderer filter exposes this interface. The Video Mixing Renderer (VMR) filter provides a better way to accomplish the same effect, through the use of multiple input streams.To use this interface, call DrawVideoImageBegin to put the Video Renderer into GDI mode. Then the application can call the DrawVideoImageDraw method as often as necessary. The renderer simply takes the current video frame and draws it to the specified rectangle. This process is asynchronous to the delivery of frames to the renderer on the filter graph thread. The application is responsible for the frame rate at which it renders images; this rate will never be the same as the rate of the frames being delivered to the filter. In other words, calling this method is like taking a periodic snapshot of the video and putting it into a device context of your choosing at a rate of your choosing. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDvdCmd.xml b/sources/Interop/Windows/Windows/um/strmif/IDvdCmd.xml index 57231cc1b8..d4afaedb98 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDvdCmd.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDvdCmd.xml @@ -4,21 +4,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The WaitForEnd method blocks the DVD Navigator until the command associated with this object completes or is canceled. Returns S_OK if successful or an HRESULT error code otherwise. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The WaitForStart method blocks the DVD Navigator until the command associated with this object begins. Returns S_OK if successful or an HRESULT error code otherwise. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDvdCmd interface waits for DVD commands to start or end. The DVD Navigator creates synchronization objects that expose this interface. The application can use the object to block the DVD Navigator until the command starts or completes. For more information on using this interface, see Synchronizing DVD Commands. (This topic also discusses other ways to synchronize commands without using synchronization objects.) diff --git a/sources/Interop/Windows/Windows/um/strmif/IDvdControl.xml b/sources/Interop/Windows/Windows/um/strmif/IDvdControl.xml index ed52a5cf6e..426241c837 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDvdControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDvdControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Sets the new display angle. Value of the new angle, which must be from 1 through 9. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Sets the current audio stream. Value that specifies the audio track to use, which must be from 0 through 7. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Searches backward through the current disc at the specified speed. Value that specifies how quickly DirectShow will search through the media file. This value is a multiplier, where 1.0 is the authored speed, so a value of 2.5 will search backward at two and one-half times the authored speed, while a value of 0.5 will search backward at half the authored speed. The actual speed of playback depends on the capabilities of the video decoder, and might differ from the specified rate. @@ -28,14 +28,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The interface is deprecated. Use instread.
Activates the selected button. This method does not return a value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Selects and activates the specified button. Value that specifies the button that will be selected and activated, which must be from 1 through 36. @@ -43,7 +43,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Plays the media file with the specified title index and chapter value. Value that specifies the title number DirectShow will play back; this value must be from 1 through 99. @@ -52,7 +52,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Instructs the DVD player to start playing at the specified chapter within the specified title and play the number of chapters specified. Title number for playback. @@ -62,7 +62,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Halts playback of the current chapter and starts playback from the specified chapter within the same title. Chapter value that specifies the point where playback will begin. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Searches forward through the current disc at the specified speed. Value that specifies how quickly DirectShow will search through the media file. This value is a multiplier, where 1.0 is the authored speed, so a value of 2.5 will search forward at two and one-half times the authored speed, while a value of 0.5 will search forward at half the authored speed. Note that the actual speed of playback depends on the capabilities of the video decoder, and might differ from the specified rate. @@ -78,14 +78,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Halts playback of the current media file and starts playback of the designated previous program chain (PGC). Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Sets the audio playback mode to karaoke. Requested audio playback mode. @@ -93,21 +93,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Selects the left directional button from the displayed menu. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Selects the lower directional button from the displayed menu. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Displays the specified menu on the screen. Value that specifies the menu to display. Member of the enumerated data type. @@ -115,7 +115,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Sets the displayed language for navigation menus. Value that specifies the new language. @@ -123,7 +123,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Selects and activates a DVD button in response to a mouse click. Specified point within the display window. @@ -131,7 +131,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Selects a DVD button in response to mouse movement. Specified point within the display window. @@ -139,14 +139,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Halts playback of the current program and starts playback from the next program within the program chain (PGC). Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Sets the current country/region for controlling parental access levels. Value that specifies the current country/region according to the Alpha-2 Code defined in ISO3166. See Remarks. @@ -154,7 +154,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Sets the parental access level for the current media file. @@ -190,42 +190,42 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Resumes playback of the current media file after a pause. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Pauses the current media file playback. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Halts playback of the current program and starts playback from the previous program within the program chain (PGC). Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Returns to playing back a title from a menu. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Selects the right directional button from the displayed menu. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Sets the root directory containing the DVD-Video volume. Pointer to the directory name to set as the root directory. @@ -233,21 +233,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Resumes playback, canceling still mode. Returns an HRESULT value . - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Transitions playback to the DVD_DOMAIN_Stop state after saving resume information. Returns an HRESULT value. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Selects the new subpicture stream and enables or disables it for display. @@ -276,7 +276,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Plays the media file with the specified title index, starting at the specified time. Value that specifies the title number DirectShow will play back; this value must be from 1 through 99. @@ -285,7 +285,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Halts playback of the current chapter and starts playback from the specified time in the same media file. Pointer to the structure where DirectShow will start playback. @@ -293,7 +293,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Finds the media file with the specified title index and plays it back. Value that specifies the title number DirectShow will play back; this value must be from 1 through 99. @@ -301,21 +301,21 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Halts playback of the current program and restarts playback of the current program within the program chain (PGC). Returns an HRESULT value . - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Selects the upper directional button from the displayed menu. Returns an HRESULT value . - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdControl interface is deprecated. Use instread.
Sets the video display mode the user prefers. Value that specifies the new display mode for DVD content. Member of the enumerated data type. @@ -323,7 +323,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. It will continue to be supported for backward compatibility with existing applications, but new applications should use .
The IDvdControl interface controls the playback and search mechanisms of a DVD title that contains one or more video movies. Use this interface to control playback (set root drive, play, stop, and so forth) or use DVD-specific functionality such as menus and buttons when playing DVD-Video files. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDvdControl2.xml b/sources/Interop/Windows/Windows/um/strmif/IDvdControl2.xml index f00505d06b..a4ab00ee06 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDvdControl2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDvdControl2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AcceptParentalLevelChange method accepts or rejects a request from the DVD Navigator to play content at a higher parental management level. Flag that indicates whether the application accepts the parental management level change. Specify TRUE to accept the change and play the higher-level content, or FALSE to reject the change. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ActivateAtPosition method activates the menu button under the mouse pointer position. Point on the client window area, in screen pixel coordinates. @@ -100,7 +100,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ActivateButton method activates the currently selected menu button. @@ -163,7 +163,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This method is deprecated. Applications should call instead. For more information, see Data Flow in the DVD Navigator.
The Pause method pauses or resumes playback at the current location. Value of type Boolean that specifies whether to pause playback; TRUE means to pause. @@ -215,7 +215,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayAtTime method starts playback from the specified time in the current title. Pointer to a structure that specifies the time at which to start playback. @@ -269,7 +269,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayAtTimeInTitle method starts playback from the specified time in the specified title. Value that specifies the number of the title to play; this value must be from 1 through 99. @@ -324,7 +324,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayBackwards method plays backward at the specified speed from the current location. Value that specifies the speed of backward play. This value is a multiplier, where 1.0 is the authored speed. So, a value of 2.5 plays backward at two and one-half times the authored speed, while a value of 0.5 plays backward at half the authored speed. The actual speed of playback depends on the video decoder's capabilities and might differ from the specified rate. For reverse play, audio is muted and no subpicture is displayed. Any speed below 0.00001 is converted to 0.00001. @@ -366,7 +366,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayChapter method starts playback from the specified chapter in the current title. Value that specifies the chapter in the current title where the DVD Navigator will start playback; this value must be from 1 through 999. @@ -420,7 +420,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayChapterInTitle method starts playback from the beginning of the specified chapter of the specified title. Value that specifies the title in which the chapter is located; this value must be from 1 through 99. @@ -475,7 +475,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayChaptersAutoStop method plays the number of chapters specified, starting at the specified chapter within the specified title. Value that specifies the title in which the chapter is located; this value must be from 1 through 99. @@ -543,7 +543,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayForwards method plays forward at the specified speed from the current location. Value that specifies the playback speed. This value is a multiplier, where 1.0 is the authored speed, so a value of 2.5 plays at two and one-half times the authored speed, while a value of 0.5 plays at half the authored speed. The actual speed of playback depends on the capabilities of the video decoder. Values below 0.00001 are converted to 0.00001. @@ -585,7 +585,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayNextChapter method starts playback from the beginning of the next chapter in the current title. Bitwise OR of one or more flags from the enumeration, specifying how to synchronize the command. @@ -626,7 +626,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayPeriodInTitleAutoStop method starts playback in the specified title from the specified start time until the specified end time. Value that specifies the title; this value must be from 1 through 99. @@ -682,7 +682,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayPrevChapter method starts playback from the beginning of the previous chapter in the current title. Bitwise OR of one or more flags from the enumeration, specifying how to synchronize the command. @@ -723,7 +723,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PlayTitle method starts playback from the beginning of the specified title. Value that specifies the title number; this value must be from 1 through 99. @@ -777,7 +777,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReplayChapter method starts playback from the beginning of the current chapter. Bitwise OR of one or more flags from the enumeration, specifying how to synchronize the command. @@ -818,7 +818,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Resume method leaves a menu and resumes playback. Bitwise OR of one or more flags from the enumeration, specifying how to synchronize the command. @@ -871,7 +871,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReturnFromSubmenu method returns the display from a submenu to its parent menu. Bitwise OR of one or more flags from the enumeration, specifying how to synchronize the command. @@ -924,7 +924,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectAndActivateButton method selects and activates the specified menu button. Value from 1 through 36 that specifies the button to select and activate. @@ -989,7 +989,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectAngle method sets the new angle when the DVD Navigator is in an angle block. Value of the new angle, which must be from 1 through 9. @@ -1068,7 +1068,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectAtPosition method highlights the menu button under the mouse pointer position. Point on the screen, in screen pixel coordinates. @@ -1120,7 +1120,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectAudioStream method selects the audio stream to play. Value that specifies the audio stream. Valid stream numbers are 0 through 7, or DVD_DEFAULT_AUDIO_STREAM to specify the default stream. @@ -1211,7 +1211,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectButton method selects the specified menu button. Value from 1 through 36 that specifies the button to select. @@ -1275,7 +1275,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectDefaultAudioLanguage method sets the default audio language. Locale identifier that specifies the default language. @@ -1329,7 +1329,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectDefaultMenuLanguage method sets the default language for all menus and menu buttons. Variable of type LCID that specifies the default language. @@ -1381,7 +1381,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectDefaultSubpictureLanguage method sets the default language for subpicture text. Locale identifier that specifies the default language. @@ -1436,7 +1436,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectKaraokeAudioPresentationMode method sends karaoke auxiliary channels to the left or right speakers. Bitwise OR of enumeration indicating how to downmix the five karaoke channels to channels 0 and 1, which are usually output to the left and right speakers. @@ -1500,7 +1500,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectParentalCountry method sets the country/region for interpreting parental access levels and setting default languages. Array of bytes that specifies the current country/region according to ISO 3166. @@ -1552,7 +1552,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectParentalLevel method sets the parental access level for the logged-on user. Value that specifies the parental access level for the current user. For details, see Remarks. @@ -1604,7 +1604,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectRelativeButton method sets the specified relative button (upper, lower, right, or left). @@ -1657,7 +1657,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectSubpictureStream method sets the subpicture stream to display. @@ -1764,7 +1764,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SelectVideoModePreference method sets the specified video mode display (wide screen, letterbox, or pan-scan) for playback. Value that specifies the new display mode for DVD content. Member of the enumeration. @@ -1828,7 +1828,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDVDDirectory method sets the DVD drive that the DVD Navigator filter will read from. Pointer to a wide-character string that specifies the path of the root directory. @@ -1892,7 +1892,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetGPRM method sets a general parameter register value. Register index; may be a value from zero through 15. @@ -1935,7 +1935,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetState method saves the current disc position and state of the DVD Navigator filter. Pointer to the interface on the object that contains the state information. @@ -1945,7 +1945,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetSubpictureState method turns the subpicture display on or off. Boolean value that specifies whether the subpicture display is on; TRUE sets subpicture display on for subsequent playback. @@ -1999,7 +1999,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ShowMenu method displays the specified menu, if available. A enumeration value that specifies the menu to display. @@ -2077,7 +2077,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StillOff method resumes playback, canceling still mode. @@ -2140,7 +2140,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Stop method stops playback of a title or menu by moving the DVD Navigator into the DVD Stop domain. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDvdGraphBuilder.xml b/sources/Interop/Windows/Windows/um/strmif/IDvdGraphBuilder.xml index fbc4de0d0d..2f15ac5a66 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDvdGraphBuilder.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDvdGraphBuilder.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDvdInterface method retrieves interfaces from the DVD-Video playback graph to make DVD-Video playback development easier. IID of the requested interface. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetFiltergraph method retrieves the interface for the filter graph used by the DVD-Video graph builder object. Address of a pointer to the interface that the DVD-Video graph builder object is using. @@ -65,7 +65,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RenderDvdVideoVolume method completes building a filter graph according to user specifications for playing a DVD-Video volume. Pointer to the path for the DVD-Video volume to play. Can be NULL. @@ -167,7 +167,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDvdGraphBuilder interface builds a filter graph for DVD-Video playback. The DVD Graph Builder object implements this interface. The method builds a DVD playback graph from the available software and hardware on the system. For information on how to build the DVD filter graph and obtain the pointers to all the necessary interfaces, see Building the DVD Filter Graph.
diff --git a/sources/Interop/Windows/Windows/um/strmif/IDvdInfo.xml b/sources/Interop/Windows/Windows/um/strmif/IDvdInfo.xml index a6bd46277c..64e13728b8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDvdInfo.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDvdInfo.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the current contents of all general parameter registers (GPRMs). Pointer to the retrieved array of general parameter registers. @@ -68,7 +68,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the current contents of all system parameter registers (SPRMs). Pointer to the retrieved array of system parameter registers. @@ -132,7 +132,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the language of the specified audio stream within the current title. Stream number. @@ -197,7 +197,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the number of available angles and the currently selected angle number. Pointer to the retrieved number of available angles. If the value pointed to equals 1, then the current video does not contain multiple angles. @@ -262,7 +262,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the number of available audio streams and the number of the currently selected audio stream. Pointer to the retrieved number of available audio streams @@ -327,7 +327,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the attributes for the current audio stream in the current title or menu. Pointer to the retrieved audio attributes. @@ -391,7 +391,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the number of available buttons and the currently selected button number. Pointer to the number of buttons available. @@ -432,7 +432,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the current DVD domain of the DVD player. Pointer to the current domain that is a member of the enumerated type. @@ -472,7 +472,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the current playback location. Pointer to the retrieved playback location information in a structure. @@ -536,7 +536,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the number of available subpicture streams, the currently selected subpicture stream number, and whether the subpicture display is disabled. Pointer to the retrieved number of available subpicture streams. @@ -602,7 +602,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the attributes for the current subpicture stream in the current title or menu. Pointer to the retrieved subpicture attributes. @@ -654,7 +654,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves which methods are currently valid. Pointer to a DWORD value containing bits for all user operations (UOP). Each bit in the DWORD represents the state (valid or not valid) of a user operation. If the bit corresponding to a user operation is set, then that user operation is prohibited. For more information, see Remarks. @@ -718,7 +718,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the current video attributes for the current title or menu. Pointer to the retrieved video attributes. @@ -782,7 +782,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the current DVD volume information. Pointer to the retrieved number of volumes in the volume set. @@ -849,7 +849,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the TXTDT_MG structure, which can contain text descriptions for title name, volume name, producer name, vocalist name, and so on, in various languages. Pointer to the retrieved text manager. @@ -915,7 +915,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the number of chapters that are defined for a given title. Title for which to retrieve the number of chapters. @@ -980,7 +980,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the current parental level and country/region code settings for the DVD player. Pointer to a value indicating the current parental level. @@ -1045,7 +1045,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the root directory that is set in the player. Pointer to the buffer to receive the root string. Note that the root string uses ANSI characters. @@ -1111,7 +1111,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the language of the specified subpicture stream within the current title. Stream number. @@ -1176,7 +1176,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves attributes of all video, audio, and subpicture streams for the specified title, including menus. Requested title number. Specify 0xFFFFFFFF for the current title. @@ -1241,7 +1241,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the parental levels that are defined for a particular title. Title for which parental levels are requested. @@ -1334,7 +1334,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves the total playback time for the current title. Pointer to the total time in format, which includes hours, minutes, seconds, and frames. @@ -1398,7 +1398,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IDvdInfo interface is deprecated. Use instead.
Retrieves attributes of all video, audio, and subpicture streams for video manager (VMG) menus. Pointer to the retrieved attributes structure. @@ -1462,7 +1462,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. It will continue to be supported for backward compatibility with existing applications, but new applications should use .
The IDvdInfo interface enables an application to query for attributes of available DVD titles and the DVD player status. It also allows for control of a DVD player beyond Annex J in the DVD specification. Use this interface to retrieve details about a DVD-Video or about the current state of the DVD player filter graph. diff --git a/sources/Interop/Windows/Windows/um/strmif/IDvdInfo2.xml b/sources/Interop/Windows/Windows/um/strmif/IDvdInfo2.xml index aae4ea587e..8136dff332 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDvdInfo2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDvdInfo2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAllGPRMs method retrieves the current contents of all general parameter registers (GPRMs). Pointer to an array of type GPRMARRAY that receives all 16 current GPRM values. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAllSPRMs method retrieves the current contents of all system parameter registers (SPRMs). Pointer to an array of type SPRMARRAY that receives the address of an array of SPRMs. @@ -84,7 +84,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAudioAttributes method retrieves the attributes of the specified audio stream in the current title or menu. Variable of type ULONG specifying the audio stream whose attributes you wish to query. See Remarks. @@ -149,7 +149,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAudioLanguage method retrieves the language of the specified audio stream within the current title. Audio stream number for the language being retrieved. @@ -226,7 +226,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetButtonAtPosition method retrieves the button located at the specified point within the display window. Current mouse pointer position as retrieved through the Win32 WM_MOUSEMOVE message. @@ -291,7 +291,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetButtonRect method retrieves the rectangle coordinates for the specified menu button.
Note  This method is currently not implemented.
@@ -322,7 +322,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCmdFromEvent method retrieves an object from an EC_DVD_CMD_START or EC_DVD_CMD_END event. Event notification's lParam1 parameter. @@ -375,7 +375,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentAngle method retrieves the number of available angles in the current angle block and the currently selected angle number. Receives the number of available angles. There are up to nine angles in an angle block, numbered 1 through 9. If the value equals 1, then the DVD Navigator is not in an angle block. @@ -428,7 +428,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentAudio method retrieves the number of available audio streams and the number of the currently selected audio stream. Receives the number of available audio streams. @@ -481,7 +481,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentButton method retrieves the number of available buttons and the number of the currently selected button. Receives the number of buttons available. @@ -522,7 +522,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentDomain method retrieves the domain in which the DVD Navigator is currently located. Pointer to a variable of type that receives the current domain. @@ -574,7 +574,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentLocation method retrieves the current playback location. Pointer to a variable of type that receives the playback location information. @@ -638,7 +638,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentSubpicture method retrieves the number of available subpicture streams in the current title, the currently selected subpicture stream number, and the state of the subpicture. Receives the number of available subpicture streams. @@ -692,7 +692,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentUOPS method retrieves a set of flags indicating which navigation commands, if any, the content authors have explicitly disabled for the current disc location. Receives a bitwise values. Each bit represents the state (valid or not valid) of a user operation (UOP). If the bit is set, then that user operation is prohibited. See Remarks. @@ -733,7 +733,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentVideoAttributes method retrieves the video attributes of the current title or menu. Pointer to a structure that receives the attributes. @@ -785,7 +785,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDecoderCaps method retrieves the DVD decoder's maximum data rate for video, audio, and subpicture (in forward and reverse) as well as support for various types of audio (AC-3, MPEG-2, DTS, SDDS, LPCM). Pointer to a variable of type that receives the information about the decoder. @@ -825,7 +825,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDefaultAudioLanguage method retrieves the default audio language. Receives the default language information. @@ -902,7 +902,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDefaultMenuLanguage method retrieves the default menu language. Receives the language information. @@ -978,7 +978,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDefaultSubpictureLanguage method retrieves the default subpicture language. Receives the language information. @@ -1055,7 +1055,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDiscID method retrieves a system-generated 64-bit identification number for the specified DVD. Path of the volume to use for the disc ID. Specify NULL to use the current or default DVD volume. @@ -1120,7 +1120,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDVDDirectory method retrieves the root directory that is set in the DVD Navigator. Pointer to a buffer that receives the path string. @@ -1174,7 +1174,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDVDTextLanguageInfo method retrieves information about the text strings for a specified language. The method retrieves the number of strings for that language, the locale identifier, and the character set. Zero-based index of the language to query. To find the number of text-string languages on the DVD, call . @@ -1242,7 +1242,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDVDTextNumberOfLanguages method retrieves the number of languages in which DVD text strings appear. Receives the number of text languages. @@ -1294,7 +1294,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDVDTextStringAsNative method retrieves a DVD text string for a specified language, and returns the text string as an array of bytes. Zero-based index of the language. To find the number of text-string languages on the DVD, call . @@ -1351,7 +1351,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDVDTextStringAsUnicode method retrieves a DVD text string for a specified language, and returns the text string as a Unicode string. Zero-based index of the language. To find the number of text-string languages on the DVD, call . @@ -1420,7 +1420,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDVDVolumeInfo method retrieves the current DVD volume information. Receives the number of volumes in the volume set. @@ -1463,7 +1463,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetKaraokeAttributes method retrieves the karaoke attributes of the specified audio stream in the current title or menu. Specifies the index of the audio stream whose attributes you want to query. See Remarks. @@ -1552,7 +1552,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMenuLanguages method retrieves all the languages available for all menus on the disc. Pointer to an LCID array that receives the languages returned. To retrieve only the number of languages available for menus, and not the actual languages themselves, specify NULL for pLanguages. @@ -1606,7 +1606,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNumberOfChapters method retrieves the number of chapters in a given title. Specifies the title. @@ -1671,7 +1671,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetPlayerParentalLevel method retrieves the current parental level and ISO 3166 country/region code settings for the DVD Navigator. Receives a value indicating the current parental level. Valid parental levels are 1 through 8 if parental management is enabled, 0xFFFFFFFF if parental management is disabled. @@ -1712,7 +1712,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetState method retrieves a bookmark containing the disc location and DVD Navigator state information. Receives a pointer to the interface of a DvdState object allocated by the DVD Navigator. @@ -1764,7 +1764,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSubpictureAttributes method retrieves the attributes of the specified subpicture stream in the specified title or menu. Index number, from 0 through 31, of the subpicture stream to query. See Remarks. @@ -1829,7 +1829,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSubpictureLanguage method retrieves the language of the specified subpicture stream within the current title. Number of the subpicture stream for which the language is being retrieved. @@ -1882,7 +1882,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTitleAttributes method retrieves attributes of all video, audio, and subpicture streams for the specified title and its menus. Variable of type ULONG, from 1 through 99, specifying the requested title number. Specify 0xFFFFFFFF for the current title. @@ -1960,7 +1960,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTitleParentalLevels method retrieves the parental levels that are defined for a particular title. Title for which parental levels are requested. Specify 0xfffffff to return the parental levels for the current title. @@ -2013,7 +2013,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTotalTitleTime method retrieves the total playback time for the current title. Pointer to a structure that receives the total time in hours, minutes, seconds, and frames. @@ -2078,7 +2078,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetVMGAttributes method retrieves attributes of all video, audio, and subpicture streams for the Video Manager Menu. Pointer to a structure that receives the attributes. @@ -2130,7 +2130,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsAudioStreamEnabled method determines if the specified audio stream is enabled in the current title. Audio stream number to test. @@ -2183,7 +2183,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsSubpictureStreamEnabled method determines if the specified subpicture stream is enabled in the current title. Subpicture stream number to test. @@ -2236,7 +2236,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDvdInfo2 interface reports attributes of a DVD disc or the current state of DVD playback and navigation. The DVD Navigator filter implements this interface. IDvdInfo2 is the companion interface to interface. IDvdInfo2 groups the DVD Navigator's "get" methods and IDvdControl2 groups the "set" methods. Together they provide DVD navigation and playback functionality beyond the DVD Annex J specification.
Note  The information provided by some of these methods can also be obtained through event notifications sent from the DVD Navigator to the application's message loop. For example, to get the current DVD domain, you can call or you can handle the EC_DVD_DOMAIN_CHANGE event in your application's message loop and extract the new domain from the event's lParam1 parameter.
diff --git a/sources/Interop/Windows/Windows/um/strmif/IDvdState.xml b/sources/Interop/Windows/Windows/um/strmif/IDvdState.xml index 8b452ce3a6..a7651f224c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IDvdState.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IDvdState.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDiscID method retrieves the unique ID of the disc from which the bookmark was made. Receives the ID. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetParentalLevel method retrieves the user's parental level as saved in the DvdState object. Receives the parental level. @@ -84,7 +84,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IDvdState interface caches the current state. The object that implements this interface is called a DVD bookmark. You can use it to save and restore the DVD state, which includes the playback location, the user's parental level, and the DVD region. diff --git a/sources/Interop/Windows/Windows/um/strmif/IEnumFilters.xml b/sources/Interop/Windows/Windows/um/strmif/IEnumFilters.xml index 4e804e66a8..64b0754cd7 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IEnumFilters.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IEnumFilters.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Clone method makes a copy of the enumerator object. The returned object starts with the same enumeration state as the original. Receives a pointer to the IEnumFilters interface of the new enumerator. The caller must release the interface. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Next method retrieves the specified number of filters in the enumeration sequence. Number of filters to retrieve. @@ -95,14 +95,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reset method resets the enumeration sequence to the beginning. Returns S_OK. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Skip method skips over a specified number of filters. Number of filters to skip. @@ -129,7 +129,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IEnumFilters interface enumerates the filters in a filter graph. To obtain this interface, call the method on the Filter Graph Manager. For more information, see Enumerating Objects in a Filter Graph. This interface implements a standard Component Object Model (COM) collection object. If the set of filters in the graph changes, some methods on this interface return VFW_E_ENUM_OUT_OF_SYNC. Call the method to resynchronize the enumerator. diff --git a/sources/Interop/Windows/Windows/um/strmif/IEnumMediaTypes.xml b/sources/Interop/Windows/Windows/um/strmif/IEnumMediaTypes.xml index 42d086176a..52387b13ba 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IEnumMediaTypes.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IEnumMediaTypes.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Clone method makes a copy of the enumerator. The returned object starts with the same enumeration state as the original. Receives a pointer to the interface of the new enumerator. The caller must release the interface. @@ -69,7 +69,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Next method retrieves a specified number of media types. The number of media types to retrieve. @@ -148,14 +148,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reset method resets the enumeration sequence to the beginning. Returns S_OK. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Skip method skips over a specified number of media types. Number of media types to skip. @@ -207,7 +207,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IEnumMediaTypes interface enumerates a pin's preferred media types. To obtain this interface, call the method on the pin. Filters use this interface when they connect to other filters. Applications can also use it to examine a pin's preferred media types. For more information, see Enumerating Objects in a Filter Graph. This interface implements a standard Component Object Model (COM) collection object. If a pin's set of preferred media types changes, some methods on this interface return VFW_E_ENUM_OUT_OF_SYNC. Call the method to resynchronize the enumerator. diff --git a/sources/Interop/Windows/Windows/um/strmif/IEnumPins.xml b/sources/Interop/Windows/Windows/um/strmif/IEnumPins.xml index 88446bf123..31aa95022c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IEnumPins.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IEnumPins.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Clone method makes a copy of the enumerator with the same enumeration state. Receives a pointer to the interface of the new enumerator. The caller must release the interface. @@ -69,7 +69,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Next method retrieves a specified number of pins in the enumeration sequence. Number of pins to retrieve. @@ -148,14 +148,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reset method resets the enumeration sequence to the beginning. Returns S_OK. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Skip method skips over a specified number of pins. Number of pins to skip. @@ -207,7 +207,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Enumerates pins on a filter. The method returns this interface. It is based on the standard Component Object Model (COM) enumerators. The filter graph manager uses this interface when it connects filters. Applications can use it to retrieve pins on a filter. For more information, see Enumerating Objects in a Filter Graph. diff --git a/sources/Interop/Windows/Windows/um/strmif/IEnumRegFilters.xml b/sources/Interop/Windows/Windows/um/strmif/IEnumRegFilters.xml index 3440d9b34e..7ff49dccf1 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IEnumRegFilters.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IEnumRegFilters.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IEnumRegFilters interface is deprecated.
This method is not currently implemented and returns E_NOTIMPL. Address of a pointer to the duplicate enumerator interface. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IEnumRegFilters interface is deprecated.
Fills the array with descriptions of the next set of filters (specified by the cFilters parameter) that meet the requirements specified upon creation of the enumerator. Number of filters. @@ -115,14 +115,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IEnumRegFilters interface is deprecated.
Resets the enumerator so that the next call to the method begins again at the first filter, if any. Returns S_OK. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IEnumRegFilters interface is deprecated.
This method is not currently implemented and returns E_NOTIMPL. Number of items to skip. @@ -130,7 +130,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. New applications should call , which enumerates monikers and returns a pointer to the IEnumMoniker interface.
This interface provides methods for enumerating registered filters. The method returns a pointer to this interface. However, has been deprecated in favor of . diff --git a/sources/Interop/Windows/Windows/um/strmif/IEnumStreamIdMap.xml b/sources/Interop/Windows/Windows/um/strmif/IEnumStreamIdMap.xml index 6ceb61c571..6fcc58f93f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IEnumStreamIdMap.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IEnumStreamIdMap.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Clone method copies the collection. Receives a pointer to the interface of the new collection object. The caller must release the interface. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Next method retrieves the next n elements in the collection. The number of elements to retrieve. @@ -22,14 +22,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reset method moves the iterator to the beginning of the collection. Returns S_OK if successful. If the method fails,an HRESULT error code is returned. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Skip method skip the element at the specified index. Index of the element to skip. @@ -37,7 +37,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IEnumStreamIdMap interface is implemented on a standard COM collection of Stream ID maps that have been created by the MPEG-2 Demultiplexer's method. To obtain a pointer to this interface, use the method. Typically, an output pin will never have more than one stream ID mapped to it at any given time. This collection represents a snapshot of the Stream IDs mapped at the time the collection is created. The collection is not updated automatically. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFileSinkFilter.xml b/sources/Interop/Windows/Windows/um/strmif/IFileSinkFilter.xml index a2b16657f0..d12f06702a 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFileSinkFilter.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFileSinkFilter.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurFile method retrieves the name and media type of the current file. Address of a pointer that receives the name of the file, as an OLESTR type. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetFileName method sets the name of the file into which media samples will be written. Pointer to the name of the file to receive the media samples. @@ -79,7 +79,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFileSinkFilter interface is implemented on filters that write media streams to a file. A file sink filter in a video capture filter graph, for instance, writes the output of the video compression filter to a file. Typically, the application running this filter graph should enable the user to enter the name of the file to be written to. This interface enables the communication of this information. If a filter needs the name of an output file, it should expose this interface to allow an application to set the file name. Note that there is currently no base class implementation of this interface. Any application that must set the name of the file into which the file sink filter will write should use this interface to get and set the file name. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFileSinkFilter2.xml b/sources/Interop/Windows/Windows/um/strmif/IFileSinkFilter2.xml index 9b7ccddb2b..00ac5e0e42 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFileSinkFilter2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFileSinkFilter2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetFileName method sets the name of the file into which media samples will be written. Pointer to the name of the file to receive the media samples. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMode method retrieves whether the file writer destroys the file when it creates the new one. Pointer to the retrieved flags. Currently, the only defined flag is AM_FILE_OVERWRITE, which indicates that the file should be destroyed; zero indicates that the file will be left alone. @@ -21,7 +21,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMode method determines whether the file writer destroys the file when it creates the new one. Currently, the only defined flag is AM_FILE_OVERWRITE, which indicates that the file writer should destroy the file. Specify zero for dwFlags to leave the file alone. @@ -29,7 +29,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFileSinkFilter2 interface extends the interface. Filters that write media streams to a file implement this interface. A file sink filter in a video capture filter graph, for instance, saves the output of the video compression filter to a file. Typically, the application running this filter graph should allow the user to enter the name of the file to which to save the data. This interface enables you to communicate this information. IFileSinkFilter2 adds the option to determine whether the file it writes should destroy an existing file of the same name. In the video capture case, do not destroy a file you've already created, because preallocating file space takes valuable time. By default, the new file does not destroy the old one. Otherwise, destroy the original file to make sure the file you author doesn't contain garbage. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFileSourceFilter.xml b/sources/Interop/Windows/Windows/um/strmif/IFileSourceFilter.xml index 93970ff2b2..6a4e361ac0 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFileSourceFilter.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFileSourceFilter.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurFile method retrieves the name and media type of the current file. Address of a pointer that receives the name of the file, as an OLESTR type. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Load method causes a source filter to load a media file. Pointer to the name of the file to open. @@ -79,7 +79,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFileSourceFilter interface is exposed by source filters to set the file name and media type of the media file that they are to render. It is an abbreviated version of the COM interface. If the file has a type that can be determined by the algorithm described in Registering a Custom File Type, the recommended file source filter CLSID is used when the filter graph manager attempts to render the filter graph. If a filter needs the name of a file to open, it should expose this interface to allow an application to set the file name. Note that there is no base class implementation of this interface. An application that inserts file source filters directly must query for this interface and set the file name. Normally, the filter graph manager uses this interface when an application calls . The Graphedt.exe tool queries for the IFileSourceFilter interface and prompts for a file name if it finds it. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFilterChain.xml b/sources/Interop/Windows/Windows/um/strmif/IFilterChain.xml index 1af5855aec..42cff9da82 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFilterChain.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFilterChain.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PauseChain method switches all the filters in a filter chain into a paused state. A pointer to the interface of the filter at the start of the chain. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RemoveChain method removes every filter in a filter chain from the filter graph. A pointer to the interface of the filter at the start of the chain. @@ -22,7 +22,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StartChain method switches all the filters in a filter chain into a running state. A pointer to the interface of the filter at the start of the chain. @@ -31,7 +31,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StopChain method switches all the filters in a filter chain into a stopped state. A pointer to the interface of the filter at the start of the chain. @@ -40,7 +40,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFilterChain interface provides methods for starting, stopping, or removing chains of filters in a filter graph. The filter graph manager exposes this interface. A filter chain is a sequence of filters, each with at most one connected input pin and one connected output pin, that forms an unbroken line of filters. A filter chain is defined by the filter at the start of the chain and the filter at the end of the chain. (These can be the same filter, making a chain of one filter.) By definition, there is a single stream path going from the start of the chain downstream to the end of the chain. The methods on this interface are useful in situations where an entire stream of data can appear or disappear, such as a video conferencing application that receives multiple streams over a network. For more information, see Dynamic Graph Building. To control individual streams on a capture filter, use the interface instead. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFilterGraph.xml b/sources/Interop/Windows/Windows/um/strmif/IFilterGraph.xml index 2a1fec9946..371fb3d3bd 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFilterGraph.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFilterGraph.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AddFilter method adds a filter to the graph. Pointer to the interface of the filter to add. @@ -106,7 +106,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ConnectDirect method connects the two pins directly (without intervening filters). Pointer to the output pin. @@ -173,7 +173,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Disconnect method disconnects this pin. Pointer to the pin to disconnect. @@ -250,7 +250,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EnumFilters method provides an enumerator for all filters in the graph. Receives a pointer to the interface. Use this interface to enumerate the filters. The caller must release the interface. @@ -303,7 +303,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FindFilterByName method finds a filter that was added to the filter graph with a specific name. [in, string] Pointer to the name to search for. @@ -357,7 +357,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reconnect method disconnects a pin and then reconnects it to the same pin. Applications should not call this method. It is called by filters during the graph building process. @@ -435,7 +435,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RemoveFilter method removes a filter from the graph. Pointer to the filter to be removed from the graph. @@ -488,7 +488,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDefaultSyncSource method sets the reference clock to the default clock. @@ -527,7 +527,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFilterGraph interface provides methods for building a filter graph. An application can use it to add filters to the graph, connect or disconnect filters, remove filters, and perform other basic operations. However, the interface inherits from this interface and provides additional methods that are more sophisticated. Therefore, applications should use IGraphBuilder rather than using IFilterGraph directly. The filter graph manager implements this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFilterGraph2.xml b/sources/Interop/Windows/Windows/um/strmif/IFilterGraph2.xml index 548558d67c..6fc2c877ae 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFilterGraph2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFilterGraph2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReconnectEx method breaks the existing pin connection and reconnects it to the same pin, using a specified media type. Applications should not call this method. It is called by filters during the graph building process. @@ -83,7 +83,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RenderEx method renders an output pin, with an option to use existing renderers only. Pointer to the interface of the output pin. @@ -93,7 +93,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFilterGraph2 interface extends the and interfaces, which contain methods for building filter graphs. The Filter Graph Manager implements this interface. Applications can use it when building graphs, to take advantage of the additional methods it provides. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFilterGraph3.xml b/sources/Interop/Windows/Windows/um/strmif/IFilterGraph3.xml index 779b6e5239..8785491e20 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFilterGraph3.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFilterGraph3.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetSyncSourceEx method establishes two reference clocks for the filter graph: a primary clock that is used by most of the filters, and a secondary clock that is used only by one specified filter. Pointer to the interface of the main reference clock. Every filter in the graph uses this clock, except for the filter specified by the pFilter parameter. @@ -46,7 +46,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFilterGraph3 interface extends the interface, which contains methods for building filter graphs. The Filter Graph Manager implements this interface. Applications can use it when building graphs, to take advantage of the additional methods it provides. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFilterMapper.xml b/sources/Interop/Windows/Windows/um/strmif/IFilterMapper.xml index 97a751fe76..1781f9f304 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFilterMapper.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFilterMapper.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IFilterMapper interface is deprecated. Use instead.
Provides an enumerator that enumerates registered filters that meet specified requirements. Address of a pointer to the enumerator returned. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IFilterMapper interface is deprecated. Use instead.
Adds a filter to the registry; the filter can then be enumerated. Globally unique identifier (GUID) of the filter. @@ -30,7 +30,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IFilterMapper interface is deprecated. Use instead.
Registers an identifiable instance of a filter. GUID of the filter. @@ -40,7 +40,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IFilterMapper interface is deprecated. Use instead.
Records the details of the pin in the registry. GUID of the filter. @@ -55,7 +55,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IFilterMapper interface is deprecated. Use instead.
Registers this pin type. Class identifier (CLSID) of the filter to which the pin belongs. @@ -66,7 +66,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IFilterMapper interface is deprecated. Use instead.
Removes the registration of this filter from the registry. GUID of the filter. @@ -74,7 +74,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IFilterMapper interface is deprecated. Use instead.
Removes the registration of this filter instance from the registry. Media resource identifier of this instance. @@ -82,7 +82,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  The IFilterMapper interface is deprecated. Use instead.
Removes the registration of this pin from the registry. GUID of the filter that this pin is part of. @@ -91,7 +91,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
Note  This interface has been deprecated. It will continue to be supported for backward compatibility with existing applications, but new applications should use the interface.
This interface provides methods for registering and unregistering filters, and for looking up filters based on their characteristics. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFilterMapper2.xml b/sources/Interop/Windows/Windows/um/strmif/IFilterMapper2.xml index d652ad77ff..587daa05c0 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFilterMapper2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFilterMapper2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CreateCategory method adds a new filter category to the registry. Class identifier (CLSID) of the new filter category. @@ -15,7 +15,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RegisterFilter method adds filter information to the registry. Class identifier (CLSID) of the filter. @@ -60,7 +60,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UnregisterFilter method removes filter information from the registry. Address of a GUID that specifies the filter category from which to remove the filter. For a list of categories, see Filter Categories. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Registers and unregisters filters, and locates filters in the registry. The Filter Mapper helper object implements this interface. Filters use this interface to register and unregister themselves. When the filter graph manager builds a filter graph, it uses this interface to look up filters and determine their characteristics. Applications can also use this interface to look up filters. For more information, see Using the Filter Mapper and How to Register DirectShow Filters. diff --git a/sources/Interop/Windows/Windows/um/strmif/IFilterMapper3.xml b/sources/Interop/Windows/Windows/um/strmif/IFilterMapper3.xml index 31688e0d89..940964718c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IFilterMapper3.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IFilterMapper3.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetICreateDevEnum method returns a pointer to the ICreateDevEnum interface. You can use the interface to create an enumerator for a category of filters, such as video capture devices or audio capture devices.
Note  This method is deprecated. Instead, applications should call CoCreateInstance with CLSID_SystemDeviceEnum to create the System Device Enumerator.
@@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IFilterMapper3 interface extends the interface. The Filter Mapper object implements this interface.
Note  This interface is deprecated.
diff --git a/sources/Interop/Windows/Windows/um/strmif/IGetCapabilitiesKey.xml b/sources/Interop/Windows/Windows/um/strmif/IGetCapabilitiesKey.xml index 836e6e4b7c..edf66c50ba 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IGetCapabilitiesKey.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IGetCapabilitiesKey.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCapabilitiesKey method gets a registry key that contains capability information for the codec. Receives a handle to the registry key. The caller must close the handle by calling RegCloseKey. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IGetCapabilitiesKey interface enables an application to retrieve the capabilities of a software or hardware codec from the registry, without creating an instance of the encoder filter. The moniker for the codec filter exposes this interface. For more information, see Encoder API. diff --git a/sources/Interop/Windows/Windows/um/strmif/IGraphBuilder.xml b/sources/Interop/Windows/Windows/um/strmif/IGraphBuilder.xml index 98a72e0dcd..9123c9aac6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IGraphBuilder.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IGraphBuilder.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Disconnect method disconnects this pin. Pointer to the pin to disconnect. @@ -81,7 +81,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EnumFilters method provides an enumerator for all filters in the graph. Receives a pointer to the interface. Use this interface to enumerate the filters. The caller must release the interface. @@ -134,7 +134,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Abort method requests the Filter Graph Manager to halt its current task as quickly as possible. The current task may or may not fail to complete. Possibly the fastest option for the Filter Graph Manager is to complete the task. @@ -142,7 +142,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AddSourceFilter method adds a source filter for a specified file to the filter graph. Specifies the name of the file to load. @@ -245,7 +245,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Connect method connects the two pins, using intermediates if necessary. Pointer to the interface on the output pin. @@ -335,7 +335,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Render method builds a filter graph that renders the data from a specified output pin. Pointer to the interface on an output pin. @@ -496,7 +496,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RenderFile method builds a filter graph that renders the specified file. Specifies a wide-character string that contains the name of a media file. @@ -718,7 +718,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetLogFile method sets the file for logging actions taken when attempting to perform an operation. Handle to the log file. @@ -726,7 +726,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ShouldOperationContinue method queries whether the current operation should continue. A filter that is performing some operation at the request of the graph can call this method to determine whether it should continue. Applications will not normally call this method. @@ -777,7 +777,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] This interface provides methods that enable an application to build a filter graph. The Filter Graph Manager implements this interface. The IGraphBuilder interface inherits from the interface. IFilterGraph provides basic operations, such as adding a filter to the graph or connecting two pins. IGraphBuilder adds further methods that construct graphs from partial information. For example, the method builds a graph for file playback, given the name of the file. The method renders data from an output pin by connecting new filters to the pin. Using these methods, an application does not need to specify every filter and pin connection in the graph. Instead, the Filter Graph Manager selects filters that are registered on the user's system, adds them to the graph, and connects them. For more information, see Intelligent Connect. diff --git a/sources/Interop/Windows/Windows/um/strmif/IGraphConfig.xml b/sources/Interop/Windows/Windows/um/strmif/IGraphConfig.xml index c952e97828..186bb73937 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IGraphConfig.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IGraphConfig.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AddFilterToCache method adds a filter to the filter cache. Pointer to the interface of the filter. @@ -69,7 +69,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EnumCacheFilter method enumerates the filters in the filter cache. Receives a pointer to the interface on the filter enumerator. The caller must release the interface. @@ -122,7 +122,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetFilterFlags method retrieves a filter's configuration information. Pointer to the interface of a filter in the filter graph. @@ -175,7 +175,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetStartTime method retrieves the reference time that was used when the filter graph was last put into a running state. Receives the start time. @@ -215,7 +215,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PushThroughData method pushes data through the filter graph to the specified pin. Pointer to the interface of an output pin in the filter graph. @@ -269,7 +269,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reconfigure method locks the filter graph and calls a callback function in the application or filter to perform a dynamic reconfiguration. Pointer to the callback interface on the application or filter. @@ -280,7 +280,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reconnect method performs a dynamic reconnection between two pins. Pointer to the interface of an output pin. Can be NULL, in which case pInputPin must not be NULL. @@ -349,7 +349,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RemoveFilterEx method removes a filter from the filter graph. Pointer to the interface of the filter to remove from the graph. @@ -358,7 +358,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RemoveFilterFromCache method removes a filter from the filter cache. Pointer to the interface of the filter to remove from the cache. @@ -411,7 +411,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetFilterFlags method sets a filter's configuration information. Pointer to the interface of a filter in the filter graph. @@ -493,7 +493,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Filter Graph Manager exposes IGraphConfig to support dynamic graph building. This interface enables applications and filters to reconfigure the filter graph while the graph is in a running state, and without losing data from the stream. The most straightforward way to rebuild the graph dynamically is to call the method. This method handles most of the details of dynamically rebuilding the graph. If a situation ever arises where you want to implement your own technique, IGraphConfig also provides the method. This method obtains a lock on the filter graph and then calls a callback function in your application, which reconfigures the graph. With this method, most of the work is shifted to your application. For more information, see Dynamic Graph Building. To optimize the process of adding and removing filters, the filter graph maintains a cache of filters. During a call to the Reconnect method, you can specify that any filters removed from the graph get added to the cache. You can also add a filter to the cache directly, if you know it is likely to be needed, by calling . The , , and methods automatically try to use filters in the cache before using other filters. Also, in the Reconnect method you can specify that only cached filters will be used for the reconnection. Note that filters held in the cache are not actually part of the graph. They are disconnected from any pins and are kept in a stopped state. diff --git a/sources/Interop/Windows/Windows/um/strmif/IGraphConfigCallback.xml b/sources/Interop/Windows/Windows/um/strmif/IGraphConfigCallback.xml index 5c370a264d..a71a352043 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IGraphConfigCallback.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IGraphConfigCallback.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Reconfigure method is a callback method passed to . Value passed in the IGraphConfig.Reconfigure method's pvContext parameter. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IGraphConfigCallback interface contains the callback method passed to . The caller (an application or filter) implements this interface. For more information, see . diff --git a/sources/Interop/Windows/Windows/um/strmif/IGraphVersion.xml b/sources/Interop/Windows/Windows/um/strmif/IGraphVersion.xml index 3ce1b5c613..7809bca45c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IGraphVersion.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IGraphVersion.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryVersion method retrieves the current graph version number. Pointer to the current graph version. @@ -81,7 +81,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IGraphVersion interface is implemented on the Filter Graph Manager to provide a way for plug-in distributors and applications to know when the graph has changed. If the graph has changed, and the application or plug-in distributor has an interface on a particular filter or pin, it should requery the graph to see if its pointers are still valid, or if there are new ones it should use. diff --git a/sources/Interop/Windows/Windows/um/strmif/IIPDVDec.xml b/sources/Interop/Windows/Windows/um/strmif/IIPDVDec.xml index 8d98fcbf5e..0b2379446f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IIPDVDec.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IIPDVDec.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The get_IPDisplay method gets the decoding resolution. Receives a member of the enumerated type, specifying the decoding resolution. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The put_IPDisplay method sets the decoding resolution. Member of the enumerated type, specifying the decoding resolution. The meaning of this value depends on whether the current format is NTSC or PAL. The filter determines at run time which format applies, based on the media type. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IIPDVDec interface provides methods for setting and retrieving properties on the DV Video Decoder filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMPEG2StreamIdMap.xml b/sources/Interop/Windows/Windows/um/strmif/IMPEG2StreamIdMap.xml index d8c6378d0b..3a88769de5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMPEG2StreamIdMap.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMPEG2StreamIdMap.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EnumStreamIdMap method returns a collection of all the mapped Stream IDs on this pin. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The MapStreamId method maps the Stream ID of an elementary stream within an MPEG-2 program stream to a media content type and substream filtering information. The stream ID of the PES stream. @@ -24,7 +24,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UnmapStreamId method unmaps the Stream ID mapping created in a previous call to MapStreamId. The number of elements in the pulStreamID array. @@ -33,7 +33,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] This interface is implemented on each output pin of the MPEG-2 Demultiplexer filter (Demux) and is used in program stream mode only. It is called by applications or other filters to associate the pin with a specified Stream ID and to inform the pin whether substream filtering is required on the stream. This interface is not exposed when the filter is playing back a file (pull-mode). For transport streams, use the IMPEG2PIDMap interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMediaEventSink.xml b/sources/Interop/Windows/Windows/um/strmif/IMediaEventSink.xml index e2f1ed94d3..295ed50ff5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMediaEventSink.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMediaEventSink.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Notify method notifies the Filter Graph Manager of an event. Identifier of the event. @@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Notifies the Filter Graph Manager of events that occur within the filter graph. Filters use this interface to report events. The Filter Graph Manager exposes this interface. Applications do not use IMediaEventSink. To retrieve events, applications use the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMediaFilter.xml b/sources/Interop/Windows/Windows/um/strmif/IMediaFilter.xml index e696ddfa26..443f9ce5c2 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMediaFilter.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMediaFilter.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetState method retrieves the filter's state (running, stopped, or paused). Time-out interval, in milliseconds. To block indefinitely, use the value INFINITE. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSyncSource method retrieves the current reference clock. Receives a pointer to the clock's interface. The caller must release the interface. @@ -111,7 +111,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Pause method pauses the filter. @@ -150,7 +150,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Run method runs the filter. Reference time corresponding to stream time 0. @@ -190,7 +190,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetSyncSource method sets the reference clock. Pointer to the clock's interface, or NULL. If this parameter is NULL, the filter graph does not use a reference clock, and all filters run as quickly as possible. @@ -198,7 +198,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Stop method stops the filter. @@ -237,7 +237,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaFilter interface controls the streaming state of a filter. All DirectShow filters implement this interface. It provides methods for switching the filter between states (stopped, paused, and running); for retrieving the filter's current state; and for setting a reference clock. Applications should not call IMediaFilter methods on filters. The Filter Graph Manager also exposes this interface. Applications can use the SetSyncSource method to set the graph reference clock, and GetSyncSource to retrieve the clock. Applications should not call the other methods on this interface. Instead, use the corresponding methods on the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMediaPropertyBag.xml b/sources/Interop/Windows/Windows/um/strmif/IMediaPropertyBag.xml index a64991967e..6be80b047d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMediaPropertyBag.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMediaPropertyBag.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EnumProperty method retrieves a property/value pair. Index value of the pair. @@ -83,7 +83,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaPropertyBag interface is exposed by the Media Property Bag object. The Media Property Bag is a specialized version of the standard COM property bag, designed for setting and retrieving INFO and DISP chunks in Audio-Video Interleaved (AVI) files. An INFO chunk contains meta-information about a file, such as author and copyright information. A DISP chunk contains data in Clipboard format. For more information, refer to the resource interchange file format (RIFF) specification. The media property bag stores the chunks as name/value pairs, as follows: diff --git a/sources/Interop/Windows/Windows/um/strmif/IMediaSample.xml b/sources/Interop/Windows/Windows/um/strmif/IMediaSample.xml index a411a18449..1bb2cb8a55 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMediaSample.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMediaSample.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetActualDataLength method retrieves the length of the valid data in the buffer. Returns the length of the valid data, in bytes. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMediaTime method retrieves the media times for this sample. Pointer to a variable that receives the media start time. @@ -52,7 +52,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMediaType method retrieves the media type, if the media type differs from the previous sample. Address of a variable that receives a pointer to an structure. If the media type has not changed from the previous sample, *ppMediaType is set to NULL. @@ -104,7 +104,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetPointer method retrieves a read/write pointer to the media sample's buffer. Receives a pointer to the buffer. @@ -112,14 +112,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSize method retrieves the size of the buffer. Returns the size of the buffer, in bytes. The size does not include the prefix bytes, if any. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTime method retrieves the stream times at which this sample should begin and finish. Pointer to a variable that receives the start time. @@ -172,28 +172,28 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsDiscontinuity method determines if this sample represents a break in the data stream. Returns S_OK if the sample is a break in the data stream. Otherwise, returns S_FALSE. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsPreroll method determines if this sample is a preroll sample. A preroll sample should not be displayed. Returns S_OK if the sample is a preroll sample. Otherwise, returns S_FALSE. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsSyncPoint method determines if the beginning of this sample is a synchronization point. Returns S_OK if the sample is a synchronization point. Otherwise, returns S_FALSE. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetActualDataLength method sets the length of the valid data in the buffer. Length of the data in the media sample, in bytes. @@ -233,7 +233,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDiscontinuity method specifies whether this sample represents a break in the data stream. Boolean value that specifies whether this sample is a discontinuity. If TRUE, the media sample is discontinuous with the previous sample. @@ -241,7 +241,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMediaTime method sets the media times for this sample. Pointer to the beginning media time. @@ -250,7 +250,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetMediaType method sets the media type for the sample. Pointer to an structure that specifies the media type. @@ -290,7 +290,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetPreroll method specifies whether this sample is a preroll sample. Boolean value that specifies whether this is a preroll sample. If TRUE, this is a preroll sample. @@ -298,7 +298,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetSyncPoint method specifies whether the beginning of this sample is a synchronization point. Boolean value that specifies whether this is a synchronization point. If TRUE, this is a synchronization point. @@ -306,7 +306,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTime method sets the stream times when this sample should begin and finish. Pointer to a variable that contains the start time of the sample. @@ -315,7 +315,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaSample interface sets and retrieves properties on media samples. A media sample is a COM object that contains a block of media data. Media samples support the use of shared memory buffers among filters. Typically, applications do not call methods on this interface. Filters use this interface to set properties on samples, and deliver the samples to a downstream filter. The downstream filter uses the interface to retrieve the properties and read the data. The filter can modify the data in place, or it can copy the sample, modify the copy, and pass the copy downstream. The interface inherits this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMediaSample2.xml b/sources/Interop/Windows/Windows/um/strmif/IMediaSample2.xml index 0b8ccd8364..afc03fb28d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMediaSample2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMediaSample2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetProperties method retrieves the properties of a media sample. Length of property data to retrieve, in bytes. @@ -46,7 +46,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetProperties method sets the properties of a media sample. Length of property data to set, in bytes. @@ -112,7 +112,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaSample2 interface sets and retrieves properties on media samples. This interface inherits the interface. Whereas the IMediaSample interface requires separate method calls for each sample property, the IMediaSample2 interface has methods for setting and retrieving multiple properties at once. Media samples are not guaranteed to support IMediaSample2. However, if an allocator creates samples that support IMediaSample2, all of the samples that it creates must support the interface. For any given media sample, the IMediaSample2.GetProperties method returns the same values as the individual IMediaSample methods. Therefore, you can use whichever version you prefer. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMediaSample2Config.xml b/sources/Interop/Windows/Windows/um/strmif/IMediaSample2Config.xml index d47da3207f..86665430c6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMediaSample2Config.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMediaSample2Config.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSurface method returns a pointer to the Direct3D surface managed by this media sample. Receives a pointer to the IUnknown interface of the Direct3D surface. The caller must release the interface. @@ -32,7 +32,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaSample2Config interface returns a pointer to a Direct3D surface representing a VRAM capture buffer. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMediaSeeking.xml b/sources/Interop/Windows/Windows/um/strmif/IMediaSeeking.xml index 6ae3d28494..876e85ba28 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMediaSeeking.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMediaSeeking.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ConvertTimeFormat method converts from one time format to another. Pointer to a variable that receives the converted time. @@ -72,7 +72,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAvailable method retrieves the range of times in which seeking is efficient. Pointer to a variable that receives the earliest time for efficient seeking. @@ -126,7 +126,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentPosition method retrieves the current position, relative to the total duration of the stream. Pointer to a variable that receives the current position, in units of the current time format. @@ -179,7 +179,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDuration method gets the duration of the stream. Receives the duration, in units of the current time format. @@ -187,7 +187,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetPositions method retrieves the current position and the stop position, relative to the total duration of the stream. Pointer to a variable that receives the current position, in units of the current time format. @@ -241,7 +241,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetPreroll method retrieves the amount of data that will be queued before the start position. Pointer to a variable that receives the preroll time, in units of the current time format. @@ -294,7 +294,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetRate method retrieves the playback rate. Pointer to a variable that receives the playback rate. @@ -347,7 +347,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetStopPosition method retrieves the time at which the playback will stop, relative to the duration of the stream. Pointer to a variable that receives the stop time, in units of the current time format. @@ -400,7 +400,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTimeFormat method retrieves the time format that is currently being used for seek operations. Pointer to a variable that receives a GUID specifying the time format. See Time Format GUIDs. @@ -441,7 +441,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsFormatSupported method determines whether a specified time format is supported for seek operations. Pointer to a GUID that specifies the time format. See Time Format GUIDs. @@ -506,7 +506,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsUsingTimeFormat method determines whether seek operations are currently using a specified time format. Pointer to a GUID that specifies the time format. See Time Format GUIDs. @@ -571,7 +571,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryPreferredFormat method retrieves the preferred time format for seeking. Pointer to a variable that receives a GUID specifying the time format. See Time Format GUIDs. @@ -624,7 +624,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetPositions method sets the current position and the stop position. [in,out] Pointer to a variable that specifies the current position, in units of the current time format. @@ -704,7 +704,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetRate method sets the playback rate. Playback rate. Must not be zero. @@ -781,7 +781,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetTimeFormat method sets the time format for subsequent seek operations. Pointer to a GUID that specifies the time format. See Time Format GUIDs. @@ -858,7 +858,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMediaSeeking interface contains methods for seeking to a position within a stream, and for setting the playback rate. The Filter Graph Manager exposes this interface, and so do individual filters or pins. Applications should query the Filter Graph Manager for the interface. The Filter Graph Manager distributes any IMediaSeeking call to each of the renderer filters in the graph. The renderer filters send the call upstream to the source filters. This sequence of events ensures that all streams remain synchronized. If any of the distributed calls returns an error, the Filter Graph Manager returns the first error value it received, even if some of the distributed calls succeed. An exception is E_NOTIMPL: the Filter Graph Manager does not return E_NOTIMPL unless it was returned by all of the distributed calls. An application can seek the graph while the graph is in any state (running, paused or stopped). If the graph is running, the Filter Graph Manager pauses the graph before it issues the seek command. Then it runs the graph again. All seeking operations are independent of the current playback rate. Seeking operations cause any pending media data to be flushed from the graph. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMemAllocator.xml b/sources/Interop/Windows/Windows/um/strmif/IMemAllocator.xml index ba1917cd0a..d27f5dbac1 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMemAllocator.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMemAllocator.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Commit method allocates the buffer memory. @@ -55,14 +55,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Decommit method releases the buffer memory. Returns S_OK if successful, or an HRESULT value indicating the cause of the error. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetBuffer method retrieves a media sample that contains an empty buffer. Receives a pointer to the buffer's interface. The caller must release the interface. @@ -141,7 +141,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetProperties method retrieves the number of buffers that the allocator will create, and the buffer properties. Pointer to an structure that receives the allocator properties. @@ -149,7 +149,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReleaseBuffer method releases a media sample. Pointer to the media sample's interface. @@ -157,7 +157,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetProperties method specifies the number of buffers to allocate and the size of each buffer. Pointer to an structure that contains the buffer requirements. @@ -235,7 +235,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMemAllocator interface allocates media samples, for moving data between pins. This interface is used by pins that share allocators, when the input pin exposes the interface. The pins negotiate which pin will provide the allocator. The allocator is used to allocate memory buffers, retrieve empty buffers, and release buffers. Not every filter creates its own allocator, so one allocator might be used by several filters. For more information, see How Filters Connect. Applications typically do not use this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMemAllocatorCallbackTemp.xml b/sources/Interop/Windows/Windows/um/strmif/IMemAllocatorCallbackTemp.xml index b9d89f0dc2..40f0e513cb 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMemAllocatorCallbackTemp.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMemAllocatorCallbackTemp.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetFreeCount method returns the number of free media samples. This number equals the total number of media samples minus the number of samples that are currently held by filters. Pointer to a variable that receives the number of free media samples. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetNotify method sets or removes a callback on the allocator. The allocator calls the callback method whenever the allocator's method is called. Pointer to the interface that will be used for the callback. The caller must implement the interface. Use the value NULL to remove the callback. @@ -53,7 +53,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMemAllocatorCallbackTemp interface enables a filter to receive a callback notification from an allocator whenever a sample is returned to the allocator's free list. The use of this interface is deprecated. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMemAllocatorNotifyCallbackTemp.xml b/sources/Interop/Windows/Windows/um/strmif/IMemAllocatorNotifyCallbackTemp.xml index e12b97e2fa..e84b6ee356 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMemAllocatorNotifyCallbackTemp.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMemAllocatorNotifyCallbackTemp.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NotifyRelease method is called whenever the allocator's method is called. The ReleaseBuffer method returns a media sample to the allocator's free list. Samples call this method when their reference counts reach zero. Return S_OK or an error code. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMemInputPin.xml b/sources/Interop/Windows/Windows/um/strmif/IMemInputPin.xml index c158a38d8f..ec4fa81b36 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMemInputPin.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMemInputPin.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAllocator method retrieves the memory allocator proposed by this pin. After the allocator has been selected, this method returns a pointer to the selected allocator. Receives a pointer to the allocator's interface. The caller must release the interface. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAllocatorRequirements method retrieves the allocator properties requested by the input pin. Pointer to an , structure which is filled in with the requirements. @@ -97,7 +97,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NotifyAllocator method specifies an allocator for the connection. Pointer to the allocator's interface. @@ -106,7 +106,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Receive method receives the next media sample in the stream. Pointer to the sample's interface. @@ -195,7 +195,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReceiveCanBlock method determines whether calls to the method might block. @@ -234,7 +234,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReceiveMultiple method receives multiple samples in the stream. Address of an array of interface pointers, of size nSamples. @@ -325,7 +325,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IMemInputPin interface delivers media data to an input pin. Input pins expose this interface if they use the interface to allocate buffers. When an output pin connects to an input pin, the output pin uses this interface to negotiate allocator requirements and deliver samples to the input pin. Applications typically do not use this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IMpeg2Demultiplexer.xml b/sources/Interop/Windows/Windows/um/strmif/IMpeg2Demultiplexer.xml index 271f334df3..c01d7053fb 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IMpeg2Demultiplexer.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IMpeg2Demultiplexer.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CreateOutputPin method creates a new output pin on the Demux. Pointer to an structure that specifies the media type information for the new pin. @@ -58,7 +58,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DeleteOutputPin method deletes the specified output pin. The friendly name of the pin as specified when the pin was created in a call to CreateOutputPin. @@ -66,7 +66,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetOutputPinMediaType method updates the media type of the specified output pin. (DirectX 9.0 and later.) The friendly name of the pin as specified when the pin was created in a call to CreateOutputPin. @@ -75,7 +75,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] This interface is implemented on the MPEG-2 Demultiplexer filter (Demux) and is used in both program stream mode and transport stream mode. It is called by applications or other filters to create, configure and delete output pins on the Demux. This interface is not exposed when the filter is playing back a file (pull-mode). diff --git a/sources/Interop/Windows/Windows/um/strmif/IOverlay.xml b/sources/Interop/Windows/Windows/um/strmif/IOverlay.xml index 8aa41bf052..3e966f190c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IOverlay.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IOverlay.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Advise method sets up an advise link for the overlay events specified by the dwInterests parameter. Pointer to the notification interface. @@ -49,7 +49,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetClipList method retrieves the clipping list. Pointer to the bounding client rectangle. @@ -59,7 +59,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetColorKey method retrieves the current color key used for chroma keying. Pointer to a variable that receives the current color key for chroma keying. @@ -67,7 +67,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDefaultColorKey method retrieves the default color key used for a chroma key overlay. Pointer to a variable that receives the default color key. @@ -75,7 +75,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetPalette method retrieves the current system palette. Pointer to a variable that receives the number of colors present. @@ -84,16 +84,16 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetVideoPosition method retrieves the current video source and destination rectangles. Pointer to a RECT structure that receives the source rectangle. - Pointer to to a RECT structure that receives the destination rectangle. + Pointer to a RECT structure that receives the destination rectangle. Returns S_OK if successful. If the method fails, it returns an HRESULT error code. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetWindowHandle method retrieves the current window handle. Receives the window handle. @@ -101,7 +101,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetColorKey method changes the color key. Pointer to the color key value to be set. If successful, the actual color key value selected is copied to this parameter. @@ -109,7 +109,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetPalette method sets the palette. Number of colors present. @@ -118,14 +118,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Unadvise method terminates the advise link established with the interface. Returns S_OK if successful. If the method fails, it returns an HRESULT error code. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IOverlay interface provides information so that a filter can write directly to video memory while placing the video in the correct window position. It is implemented on the input pin of the video renderer and communicates with an upstream filter (typically a video decompressor) by calling that filter's methods to notify it of changes to the video window. This interface has no relationship to the DirectDraw® overlay capability. The Microsoft video renderer draws data it receives through the interface, using DirectDraw overlays when available. This interface, used in place of IMemInputPin, is intended to provide notification support for any upstream filter that bypasses the renderer's drawing capabilities, but needs notifications of other display properties. See the reference page for more information on how the IOverlay and IOverlayNotify interfaces work together. diff --git a/sources/Interop/Windows/Windows/um/strmif/IOverlayNotify.xml b/sources/Interop/Windows/Windows/um/strmif/IOverlayNotify.xml index 7e9a34be14..6f0e0f74bd 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IOverlayNotify.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IOverlayNotify.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OnClipChange method provides notification that the window's visible region has changed. It is essential that any overlay hardware be updated to reflect the change to the visible region before returning from this method. Pointer to the region of the video to use. @@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OnColorKeyChange method provides notification that the window's color key has changed. Pointer to the new chroma key. @@ -22,7 +22,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OnPaletteChange method provides notification that the palette of the window has changed. Number of colors present. @@ -31,7 +31,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OnPositionChange method provides notification that the position has changed. Pointer to the source video rectangle. @@ -40,7 +40,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IOverlayNotify interface provides an upstream filter, such as a decoder, with notifications of changes to the rendering window. This includes notifications of changes to the palette, color key, and window position, and visible region (clipping) changes. Most software video decoders let the video renderer draw the decompressed images they produce by passing the media samples to the interface on the renderer's input pin. However, some video decoding filters (typically hardware decompression boards) handle the drawing of the images themselves, perhaps by using a VGA connector. These filters do not need to use , but can instead use the interface provided by the renderer input pin. Through this interface, the decoder can be notified when the window position or size changes, or when the current system palette changes in order to install and change color keys and palettes. diff --git a/sources/Interop/Windows/Windows/um/strmif/IOverlayNotify2.xml b/sources/Interop/Windows/Windows/um/strmif/IOverlayNotify2.xml index 33df61a9f0..2ca39d9712 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IOverlayNotify2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IOverlayNotify2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The OnDisplayChange method provides notification that the exposed window area has changed. Handle to the monitor used for displaying the overlay. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IOverlayNotify2 interface derives from the interface. IOverlayNotify2 gives asynchronous notifications of changes to the rendering window, identifying changes to the exposed window area. The advise link optionally supports this for the purpose of accepting notification. To get notifications that the exposed window area has changed, decoders that do their own drawing should implement an IOverlayNotify2 interface. The video renderer is the only filter that calls the method on this interface. This is done automatically by the default video renderer. diff --git a/sources/Interop/Windows/Windows/um/strmif/IPersistMediaPropertyBag.xml b/sources/Interop/Windows/Windows/um/strmif/IPersistMediaPropertyBag.xml index 899a3f93ab..8b0aa44fd5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IPersistMediaPropertyBag.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IPersistMediaPropertyBag.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The InitNew method initializes the object to receive new properties. Returns S_OK. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Save method saves properties from the filter into the media property bag. Pointer to the interface of a media property bag created by the caller. @@ -77,7 +77,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IPersistMediaPropertyBag interface sets and retrieves INFO and DISP chunks in Audio-Video Interleaved (AVI) streams. It uses the interface to store the chunks as name/value pairs. The AVI Splitter filter and the WAVE Parser filter support this interface for reading INFO and DISP chunks from an AVI or WAV file. The AVI Mux filter supports the interface for writing these chunks into a file. diff --git a/sources/Interop/Windows/Windows/um/strmif/IPin.xml b/sources/Interop/Windows/Windows/um/strmif/IPin.xml index 9c5ddfaff7..b046693a49 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IPin.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IPin.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The BeginFlush method begins a flush operation. Applications should not call this method. This method is called by other filters, to flush data from the graph. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Connect method connects the pin to another pin. Applications should not call this method. Use methods instead. This method is called by the Filter Graph Manager to connect pins. @@ -134,7 +134,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ConnectedTo method retrieves a pointer to the connected pin, if any. Receives a pointer to the interface of the other pin. The caller must release the interface. This parameter cannot be NULL. @@ -187,7 +187,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ConnectionMediaType method retrieves the media type for the current pin connection, if any. Pointer to an structure that receives the media type. @@ -240,7 +240,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Disconnect method breaks the current pin connection. The Filter Graph Manager calls this method when it disconnects two filters. Applications and filters should not call this method. Instead, call the method on the Filter Graph Manager. @@ -292,7 +292,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EndFlush method ends a flush operation. Applications should not call this method. This method is called by other filters, to flush data from the graph. @@ -332,7 +332,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EndOfStream method notifies the pin that no additional data is expected, until a new run command is issued to the filter. Applications should not call this method. This method is called by other filters to signal the end of the stream. @@ -372,7 +372,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The EnumMediaTypes method enumerates the pin's preferred media types. Receives a pointer to the interface. The caller must release the interface. @@ -437,7 +437,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NewSegment method notifies the pin that media samples received after this call are grouped as a segment, with a common start time, stop time, and rate. Applications should not call this method. This method is called by other filters. @@ -448,7 +448,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryAccept method determines whether the pin accepts a specified media type. Pointer to an structure that specifies the media type. @@ -488,7 +488,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryDirection method gets the direction of the pin (input or output). Receives a member of the enumerated type. @@ -529,7 +529,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryId method retrieves an identifier for the pin. Receives a string containing the pin identifier. @@ -582,7 +582,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryInternalConnections method retrieves the pins that are connected internally to this pin (within the filter). Address of an array of pointers. The caller allocates the array. The method fills the array with IPin pointers. If nPin is zero, this parameter can be NULL. @@ -635,7 +635,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The QueryPinInfo method retrieves information about the pin. Pointer to a structure that receives the pin information. @@ -676,7 +676,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReceiveConnection method accepts a connection from another pin. Applications should not call this method. This method is called by other filters during the pin connection process. @@ -755,7 +755,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] This interface is exposed by all input and output pins. The filter graph manager uses this interface to connect pins and perform flushing operations. Applications can use this interface to query the pin for information. Applications should never call IPin methods that change a pin's state, such as , , , or . To connect pins, an application must use the methods in . diff --git a/sources/Interop/Windows/Windows/um/strmif/IPinConnection.xml b/sources/Interop/Windows/Windows/um/strmif/IPinConnection.xml index acf7b53299..2881141fcc 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IPinConnection.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IPinConnection.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DynamicDisconnect method disconnects the pin when the filter is active (paused or running). Call this method instead of to disconnect a pin when the graph is running or paused. The caller must ensure that no data is flowing to the pin when it calls this method. Call the method on an upstream pin to block the data flow, or use some other mechanism to make sure that no samples are delivered until this pin is reconnected. @@ -44,7 +44,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DynamicQueryAccept method queries whether the pin can accept the specified media type while the graph is running with the current connection to this pin. Pointer to an structure that specifies the media type. @@ -84,7 +84,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsEndPin method indicates whether a reconnection search should end at this pin. @@ -123,7 +123,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NotifyEndOfStream method requests notification from the pin when the next end-of-stream condition occurs. Handle to an event object that the pin will signal. @@ -163,7 +163,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] This interface provides methods for reconnecting an input pin while the filter is still running. The Filter Graph Manager calls methods on this interface when it performs dynamic reconnections (see the interface). Applications might also use this interface to perform dynamic pin reconnections. Filter developers:Implement this interface on any input pin that allows dynamic reconnection or dynamic changes in format. diff --git a/sources/Interop/Windows/Windows/um/strmif/IPinFlowControl.xml b/sources/Interop/Windows/Windows/um/strmif/IPinFlowControl.xml index 29abb502fa..130d941e35 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IPinFlowControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IPinFlowControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Block method blocks or unblocks the flow of data from the pin. @@ -79,7 +79,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Blocks data flow from an active output pin. This interface is exposed by output pins that can reconnect dynamically. Use this interface to start a dynamic reconnection within the filter graph. For more information, see Dynamic Graph Building. Filter developers:Parser and capture filters that support dynamic reconnection should support this interface on their output pins. Generally, other types of filters do not need to implement this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IQualityControl.xml b/sources/Interop/Windows/Windows/um/strmif/IQualityControl.xml index 866f2dc90b..17b1e0c895 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IQualityControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IQualityControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Notify method notifies the filter that a quality change is requested. Pointer to the filter that is sending the quality notification. @@ -14,7 +14,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetSink method sets the object that will receive quality messages. Pointer to the object to which the notifications should be sent. @@ -91,7 +91,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IQualityControl interface provides support for quality control. An object exposes this interface if it can generate or receive quality-control messages. This includes renderer filters (which typically generate quality control messages), pins (which receive them), and external quality managers (which also receive them). A renderer filter generates a quality-control message by calling the method on the output pin of the upstream filter. The upstream filter either handles the message or passes it upstream. An application can implement its own quality-control manager. Call on the renderer to designate the quality-control manager as the recipient for quality-control messages. Calling this method overrides the default handling of quality-control messages. diff --git a/sources/Interop/Windows/Windows/um/strmif/IReferenceClock.xml b/sources/Interop/Windows/Windows/um/strmif/IReferenceClock.xml index b56c7deff3..572886d5e9 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IReferenceClock.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IReferenceClock.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AdviseTime method creates a one-shot advise request. Base reference time, in 100-nanosecond units. See Remarks. @@ -72,7 +72,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetTime method retrieves the current reference time. Pointer to a variable that receives the current time, in 100-nanosecond units. @@ -125,7 +125,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Unadvise method removes a pending advise request. Identifier of the request to remove. Use the value returned by or in the pdwAdviseToken parameter. @@ -165,7 +165,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IReferenceClock interface provides the reference time for the filter graph. Filters that can act as a reference clock can expose this interface. It is also exposed by the System Reference Clock. The filter graph manager uses this interface to synchronize the filter graph. Applications can use this interface to retrieve the current reference time, or to request notification of an elapsed time. For more information, see Time and Clocks in DirectShow. diff --git a/sources/Interop/Windows/Windows/um/strmif/IReferenceClockTimerControl.xml b/sources/Interop/Windows/Windows/um/strmif/IReferenceClockTimerControl.xml index 9a7c93509c..16375e5b28 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IReferenceClockTimerControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IReferenceClockTimerControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDefaultTimerResolution method returns the timer resolution that was requested by the reference clock. Receives the requested timer resolution, in 100-nanosecond units. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDefaultTimerResolution method sets the minimum timer resolution. Minimum timer resolution, in 100-nanosecond units. If the value is zero, the reference clock cancels its previous request. @@ -73,7 +73,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IReferenceClockTimerControl interface changes the timer period used by a reference clock. This interface is exposed by the DirectShow System Reference Clock. diff --git a/sources/Interop/Windows/Windows/um/strmif/IRegisterServiceProvider.xml b/sources/Interop/Windows/Windows/um/strmif/IRegisterServiceProvider.xml index e800ef92d8..db2f7400d7 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IRegisterServiceProvider.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IRegisterServiceProvider.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RegisterService method registers an object as a service. Service identifier (SID) of the service. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IRegisterServiceProvider interface registers an object as a service with the Filter Graph Manager. For more information, see . diff --git a/sources/Interop/Windows/Windows/um/strmif/IResourceConsumer.xml b/sources/Interop/Windows/Windows/um/strmif/IResourceConsumer.xml index 0121e35c54..2c3410b08a 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IResourceConsumer.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IResourceConsumer.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AcquireResource method notifies the resource consumer that a resource might be acquired. Resource identifier of the resource to be acquired. @@ -55,7 +55,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReleaseResource method requests the resource consumer to release the specified resource. Resource identifier to be released. @@ -63,7 +63,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IResourceConsumer interface provides a callback mechanism for objects using the interface. An object must implement IResourceConsumer if it uses the interface to request resources from the filter graph manager. The filter graph manager calls methods on IResourceConsumer to notify the object when a resource becomes available, or when the object should release a resource that it acquired. Applications typically do not use or implement this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IResourceManager.xml b/sources/Interop/Windows/Windows/um/strmif/IResourceManager.xml index f5da72cacc..78c64819b1 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IResourceManager.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IResourceManager.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CancelRequest method cancels the request for a resource. Resource identifier of a pending request. @@ -82,7 +82,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NotifyAcquire method notifies the resource manager that an attempt to acquire a resource has completed. Token for the registered resource. @@ -161,7 +161,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NotifyRelease method notifies the resource manager that has released a resource. Resource token. @@ -240,7 +240,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Register method registers a single named resource with the resource manager. Named resource. @@ -319,7 +319,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RegisterGroup method registers a named resource group with the resource manager. Named resource group. @@ -399,7 +399,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ReleaseFocus method sets the focus object to NULL in the resource manager if the current focus object is the one specified in this method. Pointer to the focus object. @@ -476,7 +476,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RequestResource method requests the use of a given registered resource. Resource token retrieved when the resource was registered. @@ -486,7 +486,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetFocus method notifies the resource manager that a specified object has been given the focus of the user. Pointer to the object that has been given the user's focus. @@ -563,7 +563,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IResourceManager interface resolves contentions for system resources. The filter graph manager exposes this interface. Filters can use this interface to request resources that other objects are likely to use. For example, audio renderers use this interface to resolve contentions for the wave-output device, to enable sound to follow focus. Applications will typically not use this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/ISeekingPassThru.xml b/sources/Interop/Windows/Windows/um/strmif/ISeekingPassThru.xml index 97db162f36..f6db37db25 100644 --- a/sources/Interop/Windows/Windows/um/strmif/ISeekingPassThru.xml +++ b/sources/Interop/Windows/Windows/um/strmif/ISeekingPassThru.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Init method initializes the seeking helper object. Boolean value that specifies whether the filter is a renderer. Use the value TRUE if the filter is a renderer, or FALSE otherwise. @@ -57,7 +57,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ISeekingPassThru interface creates a helper object that implements seeking for one-input filters. Filters can use this interface to implement the and interfaces. For more information, see CPosPassThru. Applications do not use this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IStreamBuilder.xml b/sources/Interop/Windows/Windows/um/strmif/IStreamBuilder.xml index 134d93b2c7..70cf99d953 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IStreamBuilder.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IStreamBuilder.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Backout method undoes steps taken in the method. This includes disconnecting and removing any filters that were added inside Render. Pointer to the interface of this pin. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Render method completes rendering of the stream originating with this pin. This can involve adding filters to the filter graph and connecting them. Pointer to the interface of this pin. @@ -22,7 +22,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IStreamBuilder interface enables an output pin to notify the filter graph manager that the pin itself will build the downstream section of the filter graph. Output pins with special connection needs can implement this interface to override the default pin connection process used by the filter graph manager. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRAspectRatioControl.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRAspectRatioControl.xml index 499e4fb396..118597a52e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRAspectRatioControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRAspectRatioControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAspectRatioMode method queries whether the VMR will preserve the aspect ratio of the source video. Pointer to a variable that receives a value indicating the aspect ratio mode. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetAspectRatioMode method specifies whether the VMR will preserve the aspect ratio of the source video. Specifies a member of the enumeration type. @@ -85,7 +85,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRAspectRatioControl interface controls whether the Video Mixing Renderer Filter 7 (VMR-7) preserves the aspect ratio of the source video. This interface is available when the VMR-7 is operating in either windowed or windowless modes. In windowless mode, the same functionality is provided by the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRDeinterlaceControl.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRDeinterlaceControl.xml index b8bf6b9801..0e92d073b1 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRDeinterlaceControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRDeinterlaceControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetActualDeinterlaceMode method returns the deinterlacing mode that the VMR is using for a specified stream. Index of the video stream. @@ -70,7 +70,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDeinterlaceMode method retrieves the deinterlacing mode for the specified video stream. Index of the video stream to check. @@ -148,7 +148,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDeinterlaceModeCaps method retrieves the capabilities of a specific deinterlacing mode supported by the graphics device driver. Pointer to a GUID that identifies the deinterlacing mode. Call the method to obtain a list of GUIDs supported by the driver. @@ -239,7 +239,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDeinterlacePrefs method queries how the VMR will select a deinterlacing mode if it cannot use the preferred deinterlacing mode. Pointer to a variable that receives a member of the enumeration. @@ -292,7 +292,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNumberOfDeinterlaceModes method retrieves the deinterlacing modes available to the VMR for the specified video format. Pointer to a structure that describes the video. @@ -359,7 +359,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDeinterlaceMode method sets the deinterlacing mode for the specified video stream. Index of the video stream to set. To set all streams, use the value 0xFFFFFFFF. @@ -425,7 +425,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDeinterlacePrefs method specifies how the VMR will select a deinterlacing mode if it cannot use the preferred deinterlacing mode. A member of the enumeration type. @@ -477,7 +477,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRDeinterlaceControl interface provides support for advanced hardware-accelerated deinterlacing using the Video Mixing Renderer Filter 7 (VMR-7). This interface enables applications or other filters to control how the VMR manages DirectX Video Acceleration (DirectX VA) hardware deinterlacing. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRFilterConfig.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRFilterConfig.xml index ebf3734344..ded27fea8c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRFilterConfig.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRFilterConfig.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNumberOfStreams method retrieves the number of input streams being mixed. Pointer to a double word that receives the number of streams being mixed, which is equal to the number of input pins on the VMR. @@ -33,7 +33,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetRenderingMode method retrieves the rendering mode currently being used by the VMR. Pointer to a DWORD that receives a value indicating the current rendering mode. @@ -62,7 +62,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetRenderingPrefs method retrieves the current set of rendering preferences being used by the VMR. Receives a member of the enumeration, indicating the current rendering preferences. @@ -103,7 +103,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetImageCompositor method installs an application-provided image compositor. Pointer to the image compositor's interface. @@ -131,7 +131,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetNumberOfStreams method sets the number of streams to be mixed and instructs the VMR to go into mixer mode. Double word containing the maximum number of input streams that the VMR will be required to mix. Must not be greater than MAX_MIXER_STREAMS (16). @@ -183,7 +183,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetRenderingMode method sets the rendering mode used by the VMR. Specifies the rendering mode as a value. @@ -223,7 +223,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetRenderingPrefs method sets various application preferences related to video rendering. Double word containing a bitwise OR of values specifying the rendering preferences. @@ -264,7 +264,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRFilterConfig interface is used to configure the operating mode and video rendering mechanisms of the Video Mixing Renderer Filter 7 (VMR-7). For the VMR-9, use the IVMRFilterConfig9 interface. Applications must add the VMR to the graph and configure it before connecting it to any upstream filters (for example, in a call to ). Once a filter has been connected to the VMR, the VMR's configuration is locked and all future attempts to alter it fail. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRImageCompositor.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRImageCompositor.xml index 6a83a8670a..f049f2602b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRImageCompositor.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRImageCompositor.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CompositeImage method composites the current frames available in each input stream. Pointer to the IUnknown interface of the Direct3D device. The compositor must cast this to a LPDIRECT3DDEVICE7 type. @@ -19,8 +19,8 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] - The InitCompositionTarget method informs the compositor that a new composition target has been created. The compositor should perform any necessary configuration work in this method. This could include attaching a Z or stencil buffer buffer for the new render target + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + The InitCompositionTarget method informs the compositor that a new composition target has been created. The compositor should perform any necessary configuration work in this method. This could include attaching a Z or stencil buffer for the new render target Pointer to the IUnknown interface of the Direct3D device object. Specifies the DirectDraw surface. @@ -28,7 +28,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetStreamMediaType method sets the media type for the input stream. Specifies the input stream. The value must be from 1 through 16. @@ -38,7 +38,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The TermCompositionTarget method informs the compositor that the current composition target is being replaced. Compositors should perform any necessary cleanup of the composition target in this method. Pointer to the IUnknown interface of the Direct3D device object. @@ -47,7 +47,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRImageCompositor interface is implemented by the default compositor for the Video Mixing Renderer Filter 7 (VMR-7). It must also be implemented by any plug-in compositor that an application provides for the VMR-7. The VMR-7 calls the methods on this interface to inform the Compositor that it should composite the incoming video frames into a single output frame. Applications do not use this interface. For the VMR-9, use the IVMRImageCompositor9 interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenter.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenter.xml index bf79cae959..07d9754e28 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenter.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenter.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PresentImage method is called at precisely the moment this video frame should be presented. An application-defined DWORD_PTR that uniquely identifies this instance of the VMR in scenarios when multiple instances of the VMR are being used with a single instance of an Allocator-Presenter. See Remarks @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StartPresenting method is called just before the video starts playing. The allocator-presenter should perform any necessary configuration in this method. An application-defined DWORD_PTR cookie that uniquely identifies this instance of the VMR for use in scenarios when one instance of the allocator-presenter is used with multiple VMR instances. @@ -21,7 +21,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The StopPresenting method is called just after the video stops playing. The allocator-presenter should perform any necessary cleanup in this method. An application-defined DWORD_PTR cookie that uniquely identifies this instance of the VMR for use in scenarios when one instance of the allocator-presenter is used with multiple VMR instances. @@ -29,7 +29,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRImagePresenter interface is implemented by the default Allocator-Presenter for the Video Mixing Renderer Filter 7 (VMR-7). It must also be implemented by any plug-in Allocator-Presenter that an application provides for the VMR-7. The VMR-7 uses the methods on this interface to inform the Allocator-Presenter that it should present the video frame contained in the supplied Direct Draw surface. Applications do not use this interface. For the VMR-9, use the IVMRImagePresenter9 interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenterConfig.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenterConfig.xml index 971a69ccf7..66188bd783 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenterConfig.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenterConfig.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetRenderingPrefs method retrieves the current rendering preferences from the VMR-7 filter's allocator-presenter. The VMR-7 filter's method calls through to this method. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetRenderingPrefs method sets the rendering preferences on the VMR-7 filter's allocator-presenter. The VMR-7 filter's method calls through to this method. @@ -22,7 +22,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRImagePresenterConfig interface provides methods for setting the rendering preferences on the allocator-presenter used by the Video Mixing Renderer Filter 7 (VMR-7). Applications should not use this interface directly. The VMR-7 filter's IVMRFilterConfig interface calls methods on this interface. The default allocator-presenter implements this interface. Custom allocator-presenters can also expose this interface. For the VMR-9, use the IVMRImagePresenterConfig9 interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenterExclModeConfig.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenterExclModeConfig.xml index 6c85b92e0c..4289d96d5f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenterExclModeConfig.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRImagePresenterExclModeConfig.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetXlcModeDDObjAndPrimarySurface method retrieves the DirectDraw object and primary surface currently being used by a VMR that has been configured for DirectDraw Exclusive Mode using the SetXlcModeDDObjAndPrimarySurface method. Retrieves the Exclusive Mode DirectDraw object created by the application. @@ -33,7 +33,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetXlcModeDDObjAndPrimarySurface method informs the VMR of the DirectDraw object and primary surface that were created by the application. Specifies the Exclusive Mode DirectDraw object created by the application. @@ -62,7 +62,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRImagePresenterExclModeConfig interface inherits from and provides methods for setting and retrieving the rendering preferences on the Exclusive Mode Allocator-Presenter. This interface is exposed on the DirectDraw Exclusive Mode Allocator-Presenter object. When applications run in DirectDraw Exclusive Mode, they must create their own DirectDraw object, configure the VMR to use the Exclusive Mode Allocator-Presenter, and use this interface to inform the VMR about the DirectDraw object and the primary surface associated with it. For more information, see DirectDraw Exclusive Mode. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRMixerBitmap.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRMixerBitmap.xml index 4f05dd9dfa..e423dc3e44 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRMixerBitmap.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRMixerBitmap.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAlphaBitmapParameters method retrieves a copy of the current image and related blending parameters. A pointer to a structure that receives the bitmap, information about the blending values, and the location to blend it. @@ -45,7 +45,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UpdateAlphaBitmapParameters method changes the bitmap location, size and blending value. A pointer to a structure. @@ -53,7 +53,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRMixerBitmap interface enables an application to blend a static image from a bitmap or DirectDraw surface onto the video stream, when using the Video Mixing Renderer Filter 7 (VMR-7).
Note  For the VMR-9, use the IVMRMixerBitmap9 interface.
diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRMixerControl.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRMixerControl.xml index ea6f94b60c..a4b9a40f40 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRMixerControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRMixerControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAlpha method retrieves the constant alpha value that is applied to this video stream. Specifies the input stream. @@ -46,7 +46,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Gets the current background color on the output rectangle. Address of a variable that receives the background color. @@ -54,7 +54,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Retrieves the mixing preferences for the stream. Address of a variable that receives a bitwise OR combination of flags. @@ -62,7 +62,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetOutputRect method retrieves the position of this stream's video rectangle within the composition rectangle. Specifies the input stream. @@ -104,7 +104,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetZOrder method retrieves this video stream's position in the Z order. Specifies the input stream. @@ -146,7 +146,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetAlpha method sets a constant alpha value that is applied to this video stream. Specifies the input stream. @@ -175,7 +175,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Sets the background color on the output rectangle. Specifies the background color. @@ -183,7 +183,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetOutputRect method sets the position of this stream within the composition rectangle. Specifies the input stream. @@ -225,7 +225,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetZOrder method sets this video stream's position in the Z-order; larger values are further away. Specifies the input stream. @@ -254,7 +254,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRMixerControl interface is enables an application to manipulate the incoming video streams on the Video Mixing Renderer Filter 7 (VMR-7). Although this interface is implemented on the filter, it is actually the mixer component that is being configured. For this reason, this interface is only available when the mixer has been loaded through a call to . This interface is intended for use by applications only; it should not be used by upstream filters. For the VMR-9, use the IVMRMixerControl9 interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRMonitorConfig.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRMonitorConfig.xml index acb4ce5678..1828eb6ccb 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRMonitorConfig.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRMonitorConfig.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAvailableMonitors method retrieves information about the monitors currently available on the system. Pointer to an array of structures that contain information about each monitor on the system. @@ -59,7 +59,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetDefaultMonitor method retrieves the default monitor that all future instances of the VMR will use for video playback. Pointer to a structure that identifies the default monitor on the system. @@ -112,7 +112,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMonitor method retrieves the monitor that this instance of the VMR is using for video playback. Pointer to a structure allocated by the caller. The method fills this structure with a GUID that identifies the monitor. @@ -165,7 +165,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDefaultMonitor method specifies the default monitor that all future instances of the VMR should use for video playback. Pointer to a structure that identifies the monitor. @@ -242,7 +242,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] On a multi-monitor system, the SetMonitor method specifies the monitor that this instance of the VMR should use for video playback. Pointer to a structure that identifies the monitor. @@ -307,7 +307,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRMonitorConfig interface is implemented by the Video Mixing Renderer Filter 7 (VMR-7). Applications use this interface to determine the capabilities of the display devices on the system and to control which device is used to display the output. For example, if the system contains a hardware DVD decoder and the VMR is rendering the output from that decoder, then on a multi-monitor system, an application must use this interface to specify the display device that is connected to the decoder. The VMR-7 supports a maximum of 15 display devices. It is the responsibility of the application to ensure that the playback window is positioned on the desired monitor before the window is displayed. Otherwise the playback window will be displayed at a location chosen by the Windows Shell (Explorer) which may not be on the desired monitor. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRSurface.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRSurface.xml index 32517c4963..6fd1f008e8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRSurface.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRSurface.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetSurface method retrieves the attached DirectDraw surface interface. Address of a variable that receives a pointer to the IDirectDrawSurface7 interface. The caller must release the interface. @@ -45,14 +45,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IsSurfaceLocked method indicates whether the DirectDraw surface attached to this media sample is locked. If the method succeeds, it returns S_OK. If it fails, it returns an error code. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The LockSurface method locks the attached DirectDraw surface. Address of a variable that receives a pointer to the locked bits. @@ -93,7 +93,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The UnlockSurface method unlocks the attached DirectDraw surface. @@ -120,7 +120,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRSurface interface is implemented on the media samples used by the Video Mixing Renderer Filter 7 (VMR-7). Filters can use this interface to access the underlying DirectDraw surface on which the media sample is based. Filters must always lock and unlock the surface using the methods available on this interface. Filters must never call lock or unlock directly on the DirectDraw surface interface returned from the method. Applications do not use this interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRSurfaceAllocator.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRSurfaceAllocator.xml index 873b2766b2..4ff4a5b07f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRSurfaceAllocator.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRSurfaceAllocator.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AdviseNotify method provides the allocator-presenter with the VMR-7 filter's interface for notification callbacks. If you are using a custom allocator-presenter, the application must call this method on the allocator-presenter, with a pointer to the VMR's IVMRSurfaceAllocatorNotify interface. The allocator-presenter uses this interface to communicate with the VMR. If you are not using a custom allocator-presenter, the application does not have to call this method. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AllocateSurface method allocates a DirectDraw surface. An application-defined DWORD_PTR cookie that uniquely identifies this instance of the VMR for use in scenarios when one instance of the allocator-presenter is used with multiple VMR instances. @@ -68,7 +68,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The FreeSurface method frees the allocated DirectDraw surface. An application-defined DWORD_PTR cookie that uniquely identifies this instance of the VMR for use in scenarios when one instance of the allocator-presenter is used with multiple VMR instances. @@ -76,7 +76,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PrepareSurface method prepares the DirectDraw surface to have the next video frame decoded into it. An application-defined DWORD_PTR cookie that uniquely identifies this instance of the VMR for use in scenarios when one instance of the allocator-presenter is used with multiple VMR instances. @@ -86,7 +86,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRSurfaceAllocator interface is implemented by the default allocator-presenter for the Video Mixing Renderer Filter 7 (VMR-7). It must also be implemented by any plug-in allocator-presenter that an application provides to the VMR-7. The VMR-7 uses the methods on this interface to allocate, prepare and free DirectDraw surfaces. Applications do not use this interface. For the VMR-9, use the IVMRSurfaceAllocator9 interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRSurfaceAllocatorNotify.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRSurfaceAllocatorNotify.xml index 6f4d22d9f0..a27a323b78 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRSurfaceAllocatorNotify.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRSurfaceAllocatorNotify.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AdviseSurfaceAllocator method is called by an application to instruct the VMR to use a custom allocator-presenter. An application-defined DWORD_PTR that uniquely identifies this instance of the VMR in scenarios when multiple instances of the VMR are being used with a single instance of an allocator-presenter. @@ -13,7 +13,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The ChangeDDrawDevice method notifies the VMR that the DirectDraw playback device has changed. For example, on a multi-monitor system, the user has moved the video rectangle from one monitor to another. Specifies the DirectDraw device. @@ -22,7 +22,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NotifyEvent method is called by the allocator-presenter to inform the VMR of any significant DirectShow events during the allocation or presentation processes. Specifies the event code. @@ -32,14 +32,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RestoreDDrawSurfaces method notifies the VMR that a DirectDraw surface "loss" has been detected. If the method succeeds, it returns S_OK. If it fails, it returns an error code. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetBorderColor method specifies to the VMR which color to use in areas of the display rectangle which are not being used for video, for example when the video is letterboxed. Specifies the border color. @@ -47,7 +47,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetDDrawDevice method sets the initial DirectDraw device and monitor to be used for video playback. Specifies the DirectDraw device. @@ -56,7 +56,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRSurfaceAllocatorNotify interface is implemented by the Video Mixing Renderer Filter 7 (VMR-7). Applications use this interface to set a custom allocator-presenter and the allocator-presenter uses this interface to inform the VMR-7 of changes to the system environment that affect the DirectDraw surfaces. In order for an application to obtain this interface, the VMR must be in renderless mode. For the VMR-9, use the IVMRSurfaceAllocatorNotify9 interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRVideoStreamControl.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRVideoStreamControl.xml index 777a86d088..1a65bf422e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRVideoStreamControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRVideoStreamControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetColorKey method retrieves the source color key currently set for this stream. Address of a structure that receives the source color key. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetStreamActiveState method retrieves the state of the stream. Receives the current state of the stream. TRUE means the stream is active; FALSE means that it is inactive. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetColorKey method sets the source color key that the VMR will use when compositing the video image. Specifies the source color key as a type. @@ -28,7 +28,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetStreamActiveState method activates or inactivates an input stream. Specifies the state of the stream. TRUE means active; FALSE means inactive. @@ -36,7 +36,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRVideoStreamControl interface is implemented on each input pin of the Video Mixing Renderer Filter 7 (VMR-7). The interface operates on the input stream represented by the pin. This interface is used by upstream filters (typically decoders) to get or set the active state of individual streams, or the source color key for the composited image. Applications in general should not use this interface. The VMR-9 input pins expose the IVMRVideoStreamControl9 interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVMRWindowlessControl.xml b/sources/Interop/Windows/Windows/um/strmif/IVMRWindowlessControl.xml index 5c74ee63b1..e1a30861df 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVMRWindowlessControl.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVMRWindowlessControl.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The DisplayModeChanged method informs the VMR that a WM_DISPLAYCHANGE message has been received by the application. @@ -31,7 +31,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetAspectRatioMode method queries whether the VMR will preserve the aspect ratio of the source video. Pointer to a variable that receives a value indicating the aspect ratio mode. @@ -72,7 +72,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetBorderColor method retrieves the current border color used by the VMR. Pointer to a COLORREF variable that receives the current border color. @@ -100,7 +100,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetColorKey method retrieves the current source color key value used by the VMR. Pointer to a COLORREF variable that receives the current color key value. @@ -128,7 +128,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetCurrentImage method retrieves a copy of the current image being displayed by the VMR. Address of a pointer to a BYTE array. @@ -156,7 +156,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMaxIdealVideoSize method retrieves the maximum video size that the VMR can display without incurring significant performance or image quality degradation. Pointer that receives the maximum ideal width. @@ -185,7 +185,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetMinIdealVideoSize method retrieves the minimum video size that the VMR can display without incurring significant performance or image quality degradation. Pointer to a LONG value that receives the minimum ideal width. @@ -214,7 +214,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetNativeVideoSize method retrieves the un-stretched video size and aspect ratio of the video. Pointer that receives the width of the native video rectangle. @@ -245,7 +245,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetVideoPosition method retrieves the current source and destination rectangles used to display the video. Pointer that receives the current source rectangle. @@ -274,7 +274,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The RepaintVideo method repaints the current video frame. Specifies the handle of the window in which the repainting should occur. @@ -303,7 +303,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetAspectRatioMode method specifies whether the VMR will preserve the aspect ratio of the source video. Specifies a member of the enumeration type. @@ -355,7 +355,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetBorderColor method sets the border color to be used by the VMR. Specifies the border color. @@ -383,7 +383,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetColorKey method sets the source color key value that the VMR should use. Specifies the source color key. @@ -411,7 +411,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetVideoClippingWindow method specifies the container window that video should be clipped to. Specifies the window to which the video should be clipped. @@ -439,7 +439,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetVideoPosition method sets the source and destination rectangles for the video. Pointer to a RECT structure that specifies the source rectangle. If NULL, the source rectangle does not change. The default source rectangle is the entire video image. @@ -468,7 +468,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVMRWindowlessControl interface controls how the Video Mixing Renderer Filter 7 (VMR-7) renders a video stream within a container window. Applications must first put the VMR-7 into windowless mode before using this interface. For the VMR-9, use the IVMRWindowlessControl9 interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVPManager.xml b/sources/Interop/Windows/Windows/um/strmif/IVPManager.xml index e5eafe3d66..f52bc5b1c4 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVPManager.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVPManager.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The GetVideoPortIndex method returns the current video port index being used by the Video Port Manager (VPM). Pointer to a double word containing the index of the video port that the VPM is currently connected to. @@ -12,7 +12,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The SetVideoPortIndex method instructs the Video Port Manager (VPM) to connect to the specified video port. Double word containing the video port index. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVPManager interface is implemented on the Video Port Manager (VPM). The interface provides methods for applications to specify and retrieve indexes for ports when there are multiple video ports on a system, and to specify and retrieve the rectangle used by the video port. Currently, only the two index-related methods are implemented. diff --git a/sources/Interop/Windows/Windows/um/strmif/IVideoFrameStep.xml b/sources/Interop/Windows/Windows/um/strmif/IVideoFrameStep.xml index 15fea8723c..113011a3b8 100644 --- a/sources/Interop/Windows/Windows/um/strmif/IVideoFrameStep.xml +++ b/sources/Interop/Windows/Windows/um/strmif/IVideoFrameStep.xml @@ -4,14 +4,14 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CancelStep method cancels the previous operation. Returns S_OK if the Step operation was successfully canceled, or E_FAIL otherwise. - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The CanStep method determines the stepping capabilities of the specified filter. If bMultiple is zero and the method returns S_OK, the graph can step one frame at a time. If bMultiple if greater than zero and the method returns S_OK, the graph can step bMultiple frames at a time. @@ -20,7 +20,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Step method causes the filter graph to step forward by the specified number of frames. Specifies the number of frames to skip. If dwFrames is 1, the graph steps forward one frame. If dwFrames is a number n greater than 1, the graph skips n - 1 frames and shows the nth frame. @@ -73,7 +73,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The IVideoFrameStep interface steps through a video stream. This interface enables Microsoft® DirectShow® applications, including DVD players, to step through a video stream as slowly as one frame at a time. Obtain the interface through the filter graph manager, which controls the frame stepping process in conjunction with the Overlay Mixer Filter or the Video Renderer Filter. Backward frame stepping is not supported.
Note  For frame stepping to work with a hardware decoder, the decoder must support the Frame Stepping Property Set.
diff --git a/sources/Interop/Windows/Windows/um/strmif/InterleavingMode.xml b/sources/Interop/Windows/Windows/um/strmif/InterleavingMode.xml index a81b6a76f3..143842066a 100644 --- a/sources/Interop/Windows/Windows/um/strmif/InterleavingMode.xml +++ b/sources/Interop/Windows/Windows/um/strmif/InterleavingMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies how video frames and audio samples will be written to disk. diff --git a/sources/Interop/Windows/Windows/um/strmif/NORMALIZEDRECT.xml b/sources/Interop/Windows/Windows/um/strmif/NORMALIZEDRECT.xml index da1234ca02..f18cc7120f 100644 --- a/sources/Interop/Windows/Windows/um/strmif/NORMALIZEDRECT.xml +++ b/sources/Interop/Windows/Windows/um/strmif/NORMALIZEDRECT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The NORMALIZEDRECT structure is used with the VMR filter in mixing operations to specify the location of a video rectangle in composition space. diff --git a/sources/Interop/Windows/Windows/um/strmif/PIN_DIRECTION.xml b/sources/Interop/Windows/Windows/um/strmif/PIN_DIRECTION.xml index da98545605..4ec880f3de 100644 --- a/sources/Interop/Windows/Windows/um/strmif/PIN_DIRECTION.xml +++ b/sources/Interop/Windows/Windows/um/strmif/PIN_DIRECTION.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates a pin's direction. diff --git a/sources/Interop/Windows/Windows/um/strmif/PIN_INFO.xml b/sources/Interop/Windows/Windows/um/strmif/PIN_INFO.xml index b0521f7fcc..38618fa575 100644 --- a/sources/Interop/Windows/Windows/um/strmif/PIN_INFO.xml +++ b/sources/Interop/Windows/Windows/um/strmif/PIN_INFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The PIN_INFO structure contains information about a pin. diff --git a/sources/Interop/Windows/Windows/um/strmif/PhysicalConnectorType.xml b/sources/Interop/Windows/Windows/um/strmif/PhysicalConnectorType.xml index e168b3ea35..83d28661dc 100644 --- a/sources/Interop/Windows/Windows/um/strmif/PhysicalConnectorType.xml +++ b/sources/Interop/Windows/Windows/um/strmif/PhysicalConnectorType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the physical type of pin (audio or video). diff --git a/sources/Interop/Windows/Windows/um/strmif/Quality.xml b/sources/Interop/Windows/Windows/um/strmif/Quality.xml index 67f1d4f186..7c4614ae6b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/Quality.xml +++ b/sources/Interop/Windows/Windows/um/strmif/Quality.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The Quality structure describes a quality message by indicating Flood or Famine in the renderer and specifying the percentage of frames to drop or add to optimize the renderer's performance. diff --git a/sources/Interop/Windows/Windows/um/strmif/QualityMessageType.xml b/sources/Interop/Windows/Windows/um/strmif/QualityMessageType.xml index 223dcd58e7..84462527f3 100644 --- a/sources/Interop/Windows/Windows/um/strmif/QualityMessageType.xml +++ b/sources/Interop/Windows/Windows/um/strmif/QualityMessageType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Describes a quality message type. diff --git a/sources/Interop/Windows/Windows/um/strmif/REGFILTER2.xml b/sources/Interop/Windows/Windows/um/strmif/REGFILTER2.xml index 0234479c7e..932d8f3981 100644 --- a/sources/Interop/Windows/Windows/um/strmif/REGFILTER2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/REGFILTER2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The REGFILTER2 structure contains information for registering a filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/REGFILTERPINS.xml b/sources/Interop/Windows/Windows/um/strmif/REGFILTERPINS.xml index ff3b60e155..ab025e12f0 100644 --- a/sources/Interop/Windows/Windows/um/strmif/REGFILTERPINS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/REGFILTERPINS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The REGFILTERPINS structure contains pin information for registering a filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/REGFILTERPINS2.xml b/sources/Interop/Windows/Windows/um/strmif/REGFILTERPINS2.xml index 8a0b1852c9..d48146a7a3 100644 --- a/sources/Interop/Windows/Windows/um/strmif/REGFILTERPINS2.xml +++ b/sources/Interop/Windows/Windows/um/strmif/REGFILTERPINS2.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The REGFILTERPINS2 structure contains information for registering a filter through the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/REGPINMEDIUM.xml b/sources/Interop/Windows/Windows/um/strmif/REGPINMEDIUM.xml index 158d5719d1..6c85b2a003 100644 --- a/sources/Interop/Windows/Windows/um/strmif/REGPINMEDIUM.xml +++ b/sources/Interop/Windows/Windows/um/strmif/REGPINMEDIUM.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The REGPINMEDIUM structure describes a pin medium for registration through the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/REGPINTYPES.xml b/sources/Interop/Windows/Windows/um/strmif/REGPINTYPES.xml index c05f21697a..0185031519 100644 --- a/sources/Interop/Windows/Windows/um/strmif/REGPINTYPES.xml +++ b/sources/Interop/Windows/Windows/um/strmif/REGPINTYPES.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The REGPINTYPES structure contains media type information for registering a filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/STREAM_ID_MAP.xml b/sources/Interop/Windows/Windows/um/strmif/STREAM_ID_MAP.xml index e1733c51ae..f4a5709b8d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/STREAM_ID_MAP.xml +++ b/sources/Interop/Windows/Windows/um/strmif/STREAM_ID_MAP.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The STREAM_ID_MAP structure describes an elementary stream within an MPEG-2 program stream. Used with the interface methods. diff --git a/sources/Interop/Windows/Windows/um/strmif/TIMECODE.xml b/sources/Interop/Windows/Windows/um/strmif/TIMECODE.xml index e899fd21f6..f1b6be261d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/TIMECODE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/TIMECODE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The TIMECODE structure contains basic timecode frame count information. diff --git a/sources/Interop/Windows/Windows/um/strmif/TIMECODE_SAMPLE.xml b/sources/Interop/Windows/Windows/um/strmif/TIMECODE_SAMPLE.xml index 6a2489b24a..b674f381c0 100644 --- a/sources/Interop/Windows/Windows/um/strmif/TIMECODE_SAMPLE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/TIMECODE_SAMPLE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The TIMECODE_SAMPLE structure contains complete timecode information. diff --git a/sources/Interop/Windows/Windows/um/strmif/TunerInputType.xml b/sources/Interop/Windows/Windows/um/strmif/TunerInputType.xml index 3c1c88a6e0..89eabb2a94 100644 --- a/sources/Interop/Windows/Windows/um/strmif/TunerInputType.xml +++ b/sources/Interop/Windows/Windows/um/strmif/TunerInputType.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the frequency of a TV tuner (cable or antenna). diff --git a/sources/Interop/Windows/Windows/um/strmif/VALID_UOP_FLAG.xml b/sources/Interop/Windows/Windows/um/strmif/VALID_UOP_FLAG.xml index e865f96a79..273ac9c474 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VALID_UOP_FLAG.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VALID_UOP_FLAG.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates which user operation (UOP) commands are currently allowed by the DVD. diff --git a/sources/Interop/Windows/Windows/um/strmif/VIDEOENCODER_BITRATE_MODE.xml b/sources/Interop/Windows/Windows/um/strmif/VIDEOENCODER_BITRATE_MODE.xml index 3ebc084ca9..24086e7ca5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VIDEOENCODER_BITRATE_MODE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VIDEOENCODER_BITRATE_MODE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VIDEOENCODER_BITRATE_MODE enumeration type defines the three types of bitrates supported by the interface. diff --git a/sources/Interop/Windows/Windows/um/strmif/VIDEO_STREAM_CONFIG_CAPS.xml b/sources/Interop/Windows/Windows/um/strmif/VIDEO_STREAM_CONFIG_CAPS.xml index f476a4c64b..96fe2153b6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VIDEO_STREAM_CONFIG_CAPS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VIDEO_STREAM_CONFIG_CAPS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VIDEO_STREAM_CONFIG_CAPS structure describes a range of video formats. Video compression and video capture filters use this structure to describe what formats they can produce.
Note   Most of this structure is deprecated, with the exception of the following structure members:guidVideoStandardMinFrameIntervalMaxFrameInterval Applications can use MinFrameInterval and MaxFrameInterval to get the range of supported frame rates from a video capture device. Applications should avoid using any of the other members of this structure. Instead, use the structure returned by the method.
diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRALLOCATIONINFO.xml b/sources/Interop/Windows/Windows/um/strmif/VMRALLOCATIONINFO.xml index 42efbfddc8..06250e0da5 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRALLOCATIONINFO.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRALLOCATIONINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRALLOCATIONINFO structure is used in the VMR-7 filter's method. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRALPHABITMAP.xml b/sources/Interop/Windows/Windows/um/strmif/VMRALPHABITMAP.xml index df3ed2c10f..83f12e7a9e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRALPHABITMAP.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRALPHABITMAP.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRALPHABITMAP structure is used in the VMR-7 filter's methods when the application is providing a static alpha-blended bitmap to be displayed on the composited video frame. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlaceCaps.xml b/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlaceCaps.xml index a9f18f7dbb..89e5f54cb6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlaceCaps.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlaceCaps.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRDeinterlaceCaps structure describes the capabilities of a deinterlacing mode. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlacePrefs.xml b/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlacePrefs.xml index 65a4d1b11a..fd97292d7e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlacePrefs.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlacePrefs.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRDeinterlacePrefs enumeration type describes the deinterlacing method that the Video Mixing Renderer Filter 7 (VMR-7) uses if the method set by the application cannot be used. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlaceTech.xml b/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlaceTech.xml index 07b1757f0e..ee57909636 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlaceTech.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRDeinterlaceTech.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRDeinterlaceTech enumeration type describes the algorithm used for deinterlacing a video stream. The flags are not mutually exclusive; drivers can set a combination of flags. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRFrequency.xml b/sources/Interop/Windows/Windows/um/strmif/VMRFrequency.xml index 141120eac5..9514abf399 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRFrequency.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRFrequency.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRFrequency structure describes the frequency of a video stream. Frequencies are described as ratios. For example, the NTSC frame rate of 29.97 fps is expressed as 30,000:1001. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRGUID.xml b/sources/Interop/Windows/Windows/um/strmif/VMRGUID.xml index a5ca5a17ba..35c1332745 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRGUID.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRGUID.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The structure and is used to identify a monitor on the system (VMR-7 only). diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRMONITORINFO.xml b/sources/Interop/Windows/Windows/um/strmif/VMRMONITORINFO.xml index 4bb6c425de..e37b786b39 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRMONITORINFO.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRMONITORINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRMONITORINFO structure is used in the method to set and retrieve information about monitors on the system (VMR-7 only). diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRMixerPrefs.xml b/sources/Interop/Windows/Windows/um/strmif/VMRMixerPrefs.xml index 744df723ed..7b4f661c32 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRMixerPrefs.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRMixerPrefs.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRMixerPrefs enumeration contains flags that specify decimation, filtering, and color space information that will be used when the video image is created on the DirectDraw surface. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRMode.xml b/sources/Interop/Windows/Windows/um/strmif/VMRMode.xml index 23adfa8db8..fc9d735afa 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRMode.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRMode.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRMode enumeration type is used in calls to the and methods to retrieve or specify the Video Mixing Renderer Filter 7 (VMR-7) rendering mode. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRPRESENTATIONINFO.xml b/sources/Interop/Windows/Windows/um/strmif/VMRPRESENTATIONINFO.xml index 453afe408a..da4feff545 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRPRESENTATIONINFO.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRPRESENTATIONINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRPRESENTATIONINFO structure is used in the method (VMR-7 only). diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRPresentationFlags.xml b/sources/Interop/Windows/Windows/um/strmif/VMRPresentationFlags.xml index a8dd289a9c..5c9dd3f93e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRPresentationFlags.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRPresentationFlags.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The structure . diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRRenderPrefs.xml b/sources/Interop/Windows/Windows/um/strmif/VMRRenderPrefs.xml index 706bb3e310..09e15e27a6 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRRenderPrefs.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRRenderPrefs.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRRenderPrefs enumeration type is used with the and methods to get and set basic rendering preferences. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRSurfaceAllocationFlags.xml b/sources/Interop/Windows/Windows/um/strmif/VMRSurfaceAllocationFlags.xml index 4f369c92ff..9fcf35289c 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRSurfaceAllocationFlags.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRSurfaceAllocationFlags.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMRSurfaceAllocationFlags enumeration is used with the method to specify surface creation parameters. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRVIDEOSTREAMINFO.xml b/sources/Interop/Windows/Windows/um/strmif/VMRVIDEOSTREAMINFO.xml index 1ac9db319b..a368566f96 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRVIDEOSTREAMINFO.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRVIDEOSTREAMINFO.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] This topic applies to Windows XP or later. The VMRVIDEOSTREAMINFO structure is used in the VMR-7 filter's call to on the image compositor. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMRVideoDesc.xml b/sources/Interop/Windows/Windows/um/strmif/VMRVideoDesc.xml index 679676610c..aee13c291b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMRVideoDesc.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMRVideoDesc.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] This topic applies to Windows XP Service Pack 1 or later. The VMRVideoDesc structure describes a video stream to be deinterlaced. diff --git a/sources/Interop/Windows/Windows/um/strmif/VMR_ASPECT_RATIO_MODE.xml b/sources/Interop/Windows/Windows/um/strmif/VMR_ASPECT_RATIO_MODE.xml index 33cab9e22b..833e76c9ca 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VMR_ASPECT_RATIO_MODE.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VMR_ASPECT_RATIO_MODE.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VMR_ASPECT_RATIO_MODE enumeration type describes whether the Video Mixing Renderer Filter 7 preserves the aspect ratio of the source video. diff --git a/sources/Interop/Windows/Windows/um/strmif/VfwCaptureDialogs.xml b/sources/Interop/Windows/Windows/um/strmif/VfwCaptureDialogs.xml index 648613a456..35140e4e2d 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VfwCaptureDialogs.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VfwCaptureDialogs.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies a dialog box that might exist in a Video for Windows capture driver. diff --git a/sources/Interop/Windows/Windows/um/strmif/VfwCompressDialogs.xml b/sources/Interop/Windows/Windows/um/strmif/VfwCompressDialogs.xml index 6266c6eb93..c09c1781de 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VfwCompressDialogs.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VfwCompressDialogs.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies a dialog box that might exist in a Video for Windows compression (codec) driver. diff --git a/sources/Interop/Windows/Windows/um/strmif/VideoControlFlags.xml b/sources/Interop/Windows/Windows/um/strmif/VideoControlFlags.xml index 52466e4ef3..c3c7f4edc7 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VideoControlFlags.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VideoControlFlags.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the video mode of operation for a video device. diff --git a/sources/Interop/Windows/Windows/um/strmif/VideoProcAmpFlags.xml b/sources/Interop/Windows/Windows/um/strmif/VideoProcAmpFlags.xml index 2ffd68c41d..5fc9c38019 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VideoProcAmpFlags.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VideoProcAmpFlags.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VideoProcAmpFlags enumeration indicates whether a particular video property is controlled manually or automatically. diff --git a/sources/Interop/Windows/Windows/um/strmif/VideoProcAmpProperty.xml b/sources/Interop/Windows/Windows/um/strmif/VideoProcAmpProperty.xml index ec3d9a4785..23b4fb74f1 100644 --- a/sources/Interop/Windows/Windows/um/strmif/VideoProcAmpProperty.xml +++ b/sources/Interop/Windows/Windows/um/strmif/VideoProcAmpProperty.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The VideoProcAmpProperty enumeration specifies video properties on a video capture device. diff --git a/sources/Interop/Windows/Windows/um/strmif/_AMRESCTL_RESERVEFLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/_AMRESCTL_RESERVEFLAGS.xml index 31e6eee3d7..a5aa153651 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_AMRESCTL_RESERVEFLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_AMRESCTL_RESERVEFLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies whether to increment or decrement the number of resources currently being reserved. diff --git a/sources/Interop/Windows/Windows/um/strmif/_AM_AUDIO_RENDERER_STAT_PARAM.xml b/sources/Interop/Windows/Windows/um/strmif/_AM_AUDIO_RENDERER_STAT_PARAM.xml index acfa8529f9..7b0f181367 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_AM_AUDIO_RENDERER_STAT_PARAM.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_AM_AUDIO_RENDERER_STAT_PARAM.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The _AM_AUDIO_RENDERER_STAT_PARAM enumeration specifies which performance information to retrieve from the audio renderer. This enumeration type is used in the method. Each enumeration member defines the meaning of the values that are returned in the pdwParam1 and pdwParam2 parameters of GetStatParam.
[!NOTE] Bias-free Communication Microsoft supports a diverse and inclusionary environment. Within this document, there are references to the word 'slave.' Microsoft's Style Guide for Bias-Free Communications recognizes this as an exclusionary word. This wording is used as it is currently the wording used within the software. For consistency, this document contains this word. When this word is removed from the software, we will correct this document to be in alignment.
diff --git a/sources/Interop/Windows/Windows/um/strmif/_AM_FILTER_MISC_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/_AM_FILTER_MISC_FLAGS.xml index 46ace23a3e..affc65739e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_AM_FILTER_MISC_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_AM_FILTER_MISC_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The _AM_FILTER_MISC_FLAGS enumeration contains flags that indicate whether a filter is a source filter or a renderer filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/_AM_INTF_SEARCH_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/_AM_INTF_SEARCH_FLAGS.xml index 128bf2e9fb..78de27490b 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_AM_INTF_SEARCH_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_AM_INTF_SEARCH_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies the types of object to search, when attempting to find an interface on the filter graph. diff --git a/sources/Interop/Windows/Windows/um/strmif/_AM_OVERLAY_NOTIFY_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/_AM_OVERLAY_NOTIFY_FLAGS.xml index 6ba55de5f1..3303c0a0ae 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_AM_OVERLAY_NOTIFY_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_AM_OVERLAY_NOTIFY_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The AM_OVERLAY_NOTIFY_FLAGS enumeration indicates what the overlay has changed, or is about to change. diff --git a/sources/Interop/Windows/Windows/um/strmif/_AM_PIN_FLOW_CONTROL_BLOCK_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/_AM_PIN_FLOW_CONTROL_BLOCK_FLAGS.xml index ea3862c057..656c80255a 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_AM_PIN_FLOW_CONTROL_BLOCK_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_AM_PIN_FLOW_CONTROL_BLOCK_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Defines flags that specify how to block data flow from an output pin. diff --git a/sources/Interop/Windows/Windows/um/strmif/_AM_PUSHSOURCE_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/_AM_PUSHSOURCE_FLAGS.xml index c728f9136e..e20e6235f1 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_AM_PUSHSOURCE_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_AM_PUSHSOURCE_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the behavior of a live source filter. diff --git a/sources/Interop/Windows/Windows/um/strmif/_DVENCODERFORMAT.xml b/sources/Interop/Windows/Windows/um/strmif/_DVENCODERFORMAT.xml index 42114e63e4..a0537837c9 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_DVENCODERFORMAT.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_DVENCODERFORMAT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the digital video (DV) format. diff --git a/sources/Interop/Windows/Windows/um/strmif/_DVENCODERRESOLUTION.xml b/sources/Interop/Windows/Windows/um/strmif/_DVENCODERRESOLUTION.xml index 6e31f41b0d..8d1c24ea9e 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_DVENCODERRESOLUTION.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_DVENCODERRESOLUTION.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the digital video (DV) encoding resolution. diff --git a/sources/Interop/Windows/Windows/um/strmif/_DVENCODERVIDEOFORMAT.xml b/sources/Interop/Windows/Windows/um/strmif/_DVENCODERVIDEOFORMAT.xml index bcc901ba51..0a470e21f0 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_DVENCODERVIDEOFORMAT.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_DVENCODERVIDEOFORMAT.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the video standard (NTSC or PAL) for digital video (DV) encoding. diff --git a/sources/Interop/Windows/Windows/um/strmif/_DVRESOLUTION.xml b/sources/Interop/Windows/Windows/um/strmif/_DVRESOLUTION.xml index de64eca0b1..b983a73cf0 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_DVRESOLUTION.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_DVRESOLUTION.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Indicates the digital video (DV) decoding resolution. diff --git a/sources/Interop/Windows/Windows/um/strmif/_REM_FILTER_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/_REM_FILTER_FLAGS.xml index 514cb13c81..f352247606 100644 --- a/sources/Interop/Windows/Windows/um/strmif/_REM_FILTER_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/_REM_FILTER_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies how to remove a filter from the filter graph. diff --git a/sources/Interop/Windows/Windows/um/strmif/tagAM_SAMPLE_PROPERTY_FLAGS.xml b/sources/Interop/Windows/Windows/um/strmif/tagAM_SAMPLE_PROPERTY_FLAGS.xml index 6e9716b8b1..b1c7da25e1 100644 --- a/sources/Interop/Windows/Windows/um/strmif/tagAM_SAMPLE_PROPERTY_FLAGS.xml +++ b/sources/Interop/Windows/Windows/um/strmif/tagAM_SAMPLE_PROPERTY_FLAGS.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] Specifies values for the structure. These values describe the properties of media samples. diff --git a/sources/Interop/Windows/Windows/um/sysinfoapi/DEVELOPER_DRIVE_ENABLEMENT_STATE.xml b/sources/Interop/Windows/Windows/um/sysinfoapi/DEVELOPER_DRIVE_ENABLEMENT_STATE.xml new file mode 100644 index 0000000000..8b39655ea4 --- /dev/null +++ b/sources/Interop/Windows/Windows/um/sysinfoapi/DEVELOPER_DRIVE_ENABLEMENT_STATE.xml @@ -0,0 +1,20 @@ + + + + + + An enum of possible values for the developer drive enablement state. + + + Indicates that there was an error determining the developer drive enablement state. After this is returned, call to get the error value. + + + Indicates that the developer drive is enabled. + + + Indicates that the developer drive is disabled by system policy. + + + Indicates that the developer drive is disabled by group policy. + + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/sysinfoapi/Windows.xml b/sources/Interop/Windows/Windows/um/sysinfoapi/Windows.xml index 2ca3278637..a2b1715cf2 100644 --- a/sources/Interop/Windows/Windows/um/sysinfoapi/Windows.xml +++ b/sources/Interop/Windows/Windows/um/sysinfoapi/Windows.xml @@ -870,6 +870,10 @@ + + Gets a value indicating whether the developer drive is enabled. + Returns a value indicating the developer drive enablement state. + Retrieves the best estimate of the diagonal size of the built-in screen, in inches. The best estimate of the diagonal size of the built-in screen, in inches. @@ -2745,12 +2749,12 @@ Applications not manifested for Windows 8.1 or Windows 10 will return the Windows 8 OS version value (6.2). Once an application is manifested for a given operating system version, GetVersionEx will always return the version that the application is manifested for in future releases. To manifest your applications for Windows 8.1 or Windows 10, refer to Targeting your application for Windows. - An or structure that receives the operating system information. + An or structure that receives the operating system information. Before calling theGetVersionEx function, set the dwOSVersionInfoSize member of the structure as appropriate to indicate which data structure is being passed to this function. If the function succeeds, the return value is a nonzero value. - If the function fails, the return value is zero. To get extended error information, call. The function fails if you specify an invalid value for the dwOSVersionInfoSize member of the or structure. + If the function fails, the return value is zero. To get extended error information, call. The function fails if you specify an invalid value for the dwOSVersionInfoSize member of the or structure. @@ -2761,12 +2765,12 @@ Applications not manifested for Windows 8.1 or Windows 10 will return the Windows 8 OS version value (6.2). Once an application is manifested for a given operating system version, GetVersionEx will always return the version that the application is manifested for in future releases. To manifest your applications for Windows 8.1 or Windows 10, refer to Targeting your application for Windows. - An or structure that receives the operating system information. + An or structure that receives the operating system information. Before calling theGetVersionEx function, set the dwOSVersionInfoSize member of the structure as appropriate to indicate which data structure is being passed to this function. If the function succeeds, the return value is a nonzero value. - If the function fails, the return value is zero. To get extended error information, call. The function fails if you specify an invalid value for the dwOSVersionInfoSize member of the or structure. + If the function fails, the return value is zero. To get extended error information, call. The function fails if you specify an invalid value for the dwOSVersionInfoSize member of the or structure. @@ -2777,12 +2781,12 @@ Applications not manifested for Windows 8.1 or Windows 10 will return the Windows 8 OS version value (6.2). Once an application is manifested for a given operating system version, GetVersionEx will always return the version that the application is manifested for in future releases. To manifest your applications for Windows 8.1 or Windows 10, refer to Targeting your application for Windows. - An or structure that receives the operating system information. + An or structure that receives the operating system information. Before calling theGetVersionEx function, set the dwOSVersionInfoSize member of the structure as appropriate to indicate which data structure is being passed to this function. If the function succeeds, the return value is a nonzero value. - If the function fails, the return value is zero. To get extended error information, call. The function fails if you specify an invalid value for the dwOSVersionInfoSize member of the or structure. + If the function fails, the return value is zero. To get extended error information, call. The function fails if you specify an invalid value for the dwOSVersionInfoSize member of the or structure. diff --git a/sources/Interop/Windows/Windows/um/wincodec/WICDdsAlphaMode.xml b/sources/Interop/Windows/Windows/um/wincodec/WICDdsAlphaMode.xml index e56b48a5ba..9187336362 100644 --- a/sources/Interop/Windows/Windows/um/wincodec/WICDdsAlphaMode.xml +++ b/sources/Interop/Windows/Windows/um/wincodec/WICDdsAlphaMode.xml @@ -3,7 +3,7 @@ - Specifies the the meaning of pixel color component values contained in the DDS image. + Specifies the meaning of pixel color component values contained in the DDS image. Alpha behavior is unspecified and must be determined by the reader. diff --git a/sources/Interop/Windows/Windows/um/wincrypt/CRYPT_ALGORITHM_IDENTIFIER.xml b/sources/Interop/Windows/Windows/um/wincrypt/CRYPT_ALGORITHM_IDENTIFIER.xml index c75df4ccc1..b984b75448 100644 --- a/sources/Interop/Windows/Windows/um/wincrypt/CRYPT_ALGORITHM_IDENTIFIER.xml +++ b/sources/Interop/Windows/Windows/um/wincrypt/CRYPT_ALGORITHM_IDENTIFIER.xml @@ -7,8 +7,7 @@ - An OID of an algorithm. This member can be one of the following values. This list is only representative. New algorithms are being defined by - various users. + An OID of an algorithm. This member can be one of the following values. This list is only representative. New algorithms are being defined by various users. Value diff --git a/sources/Interop/Windows/Windows/um/wincrypt/Windows.xml b/sources/Interop/Windows/Windows/um/wincrypt/Windows.xml index 57956b0746..5d6c8abf02 100644 --- a/sources/Interop/Windows/Windows/um/wincrypt/Windows.xml +++ b/sources/Interop/Windows/Windows/um/wincrypt/Windows.xml @@ -6287,7 +6287,44 @@ The CertOpenServerOcspResponse function opens a handle to an online certificate status protocol (OCSP) response associated with a server certificate chain. The address of a structure that contains the certificate chain. - This parameter is not used and must be zero. + + + + Value + Meaning + + + + + + + 0 + + + + 0x00000000 + + + + This API will try to retrieve an initial OCSP response before returning, which means it will block during the retrieval. + + + + + + + CERT_SERVER_OCSP_RESPONSE_ASYNC_FLAG + + + + 0x00000001 + + + + Set this flag to return immediately without making the initial synchronous retrieval. + + + This parameter is not used and must be NULL. Returns a handle to the OCSP response associated with a server certificate chain if successful; otherwise, NULL. This handle must be passed to the function when it is no longer needed. diff --git a/sources/Interop/Windows/Windows/um/wingdi/BITMAPFILEHEADER.xml b/sources/Interop/Windows/Windows/um/wingdi/BITMAPFILEHEADER.xml index 364880f939..d44e5fc432 100644 --- a/sources/Interop/Windows/Windows/um/wingdi/BITMAPFILEHEADER.xml +++ b/sources/Interop/Windows/Windows/um/wingdi/BITMAPFILEHEADER.xml @@ -6,7 +6,7 @@ The BITMAPFILEHEADER structure contains information about the type, size, and layout of a file that contains a DIB. - The file type; must be BM. + The file type; must be 0x4d42 (the ASCII string "BM"). The size, in bytes, of the bitmap file. diff --git a/sources/Interop/Windows/Windows/um/wingdi/BITMAPINFOHEADER.xml b/sources/Interop/Windows/Windows/um/wingdi/BITMAPINFOHEADER.xml index a5a4002847..6491a14395 100644 --- a/sources/Interop/Windows/Windows/um/wingdi/BITMAPINFOHEADER.xml +++ b/sources/Interop/Windows/Windows/um/wingdi/BITMAPINFOHEADER.xml @@ -4,7 +4,7 @@ - [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer and . MediaPlayer and IMFMediaEngine have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] + [The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, , and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.] The BITMAPINFOHEADER structure contains information about the dimensions and color format of a device-independent bitmap (DIB).
Note  This structure is also described in the GDI documentation. However, the semantics for video data are slightly different than the semantics used for GDI. If you are using this structure to describe video data, use the information given here.
diff --git a/sources/Interop/Windows/Windows/um/wingdi/DEVMODEW.xml b/sources/Interop/Windows/Windows/um/wingdi/DEVMODEW.xml index be6122ad03..edfd82942e 100644 --- a/sources/Interop/Windows/Windows/um/wingdi/DEVMODEW.xml +++ b/sources/Interop/Windows/Windows/um/wingdi/DEVMODEW.xml @@ -221,8 +221,22 @@ - For displays, specifies a display device's display mode. This member can be one of the following values: - This member is not used for printers. + Specifies the device's display mode. This member can be a combination of the following values. + + + Value + Meaning + + + DM_GRAYSCALE + Specifies that the display is a noncolor device. If this flag is not set, color is assumed. This flag is no longer valid. + + + DM_INTERLACED + Specifies that the display mode is interlaced. If the flag is not set, noninterlaced is assumed. + + + Display drivers use this member; for example, in the function. Printer drivers don't use this member. diff --git a/sources/Interop/Windows/Windows/um/wingdi/LOGPEN.xml b/sources/Interop/Windows/Windows/um/wingdi/LOGPEN.xml index da3bf545f2..5dff68bd3c 100644 --- a/sources/Interop/Windows/Windows/um/wingdi/LOGPEN.xml +++ b/sources/Interop/Windows/Windows/um/wingdi/LOGPEN.xml @@ -45,7 +45,7 @@ - The structure that contains the pen width, in logical units. If the pointer member is NULL, the pen is one pixel wide on raster devices. The y member in the POINT structure for lopnWidth is not used. + The structure that contains the pen width, in logical units. If the x member is NULL, then the pen is one pixel wide on raster devices. The y member in the POINT structure for lopnWidth isn't used. The pen color. To generate a COLORREF structure, use the macro. diff --git a/sources/Interop/Windows/Windows/um/winhttp/Windows.xml b/sources/Interop/Windows/Windows/um/winhttp/Windows.xml index fa3accb2df..755499539d 100644 --- a/sources/Interop/Windows/Windows/um/winhttp/Windows.xml +++ b/sources/Interop/Windows/Windows/um/winhttp/Windows.xml @@ -3812,7 +3812,7 @@ - ERROR_INVALID_SERVER_RESPONSE + ERROR_WINHTTP_INVALID_SERVER_RESPONSE diff --git a/sources/Interop/Windows/Windows/um/winioctl/REQUEST_OPLOCK_OUTPUT_BUFFER.xml b/sources/Interop/Windows/Windows/um/winioctl/REQUEST_OPLOCK_OUTPUT_BUFFER.xml index f2ab8dd774..6cbdeb1c54 100644 --- a/sources/Interop/Windows/Windows/um/winioctl/REQUEST_OPLOCK_OUTPUT_BUFFER.xml +++ b/sources/Interop/Windows/Windows/um/winioctl/REQUEST_OPLOCK_OUTPUT_BUFFER.xml @@ -59,7 +59,7 @@ - If the REQUEST_OPLOCK_OUTPUT_FLAG_MODES_PROVIDED flag is set and theOPLOCK_LEVEL_CACHE_HANDLE level is being lost in an oplock break, contains the access mode mode of the request that is causing the break. + If the REQUEST_OPLOCK_OUTPUT_FLAG_MODES_PROVIDED flag is set and theOPLOCK_LEVEL_CACHE_HANDLE level is being lost in an oplock break, contains the access mode of the request that is causing the break. If the REQUEST_OPLOCK_OUTPUT_FLAG_MODES_PROVIDED flag is set and theOPLOCK_LEVEL_CACHE_HANDLE level is being lost in an oplock break, contains the share mode of the request that is causing the break. diff --git a/sources/Interop/Windows/Windows/um/winioctl/USN_RECORD_V3.xml b/sources/Interop/Windows/Windows/um/winioctl/USN_RECORD_V3.xml index 7a01b47aa2..dbd3978ddb 100644 --- a/sources/Interop/Windows/Windows/um/winioctl/USN_RECORD_V3.xml +++ b/sources/Interop/Windows/Windows/um/winioctl/USN_RECORD_V3.xml @@ -190,7 +190,7 @@ - The user made a change to the extended attributes of a file or directory.These NTFS file system attributes are not accessible to Windows-based applications. + The user made a change to the extended attributes of a file or directory. diff --git a/sources/Interop/Windows/Windows/um/winnt/ACL.xml b/sources/Interop/Windows/Windows/um/winnt/ACL.xml index 78768b5995..dcdf7f2d6c 100644 --- a/sources/Interop/Windows/Windows/um/winnt/ACL.xml +++ b/sources/Interop/Windows/Windows/um/winnt/ACL.xml @@ -12,7 +12,7 @@ Specifies a zero byte of padding that aligns the AclRevision member on a 16-bit boundary. - Specifies the size, in bytes, of the ACL. This value includes both the ACL structure and all the ACEs. + Specifies the size, in bytes, of the ACL. This value includes the ACL structure, all the ACEs, and the potential unused memory. Specifies the number of ACEs stored in the ACL. diff --git a/sources/Interop/Windows/Windows/um/winnt/MEM_ADDRESS_REQUIREMENTS.xml b/sources/Interop/Windows/Windows/um/winnt/MEM_ADDRESS_REQUIREMENTS.xml index a9979aa0c7..7c0e0ee40a 100644 --- a/sources/Interop/Windows/Windows/um/winnt/MEM_ADDRESS_REQUIREMENTS.xml +++ b/sources/Interop/Windows/Windows/um/winnt/MEM_ADDRESS_REQUIREMENTS.xml @@ -6,10 +6,10 @@ Specifies a lowest and highest base address and alignment as part of an extended parameter to a function that manages virtual memory. - Specifies the lowest acceptable address. Calling <a href=" and specifying NULL for LowestStartingAddress, and specifying NULL for LowestStartingAddress, gives the same behavior as calling /. + Specifies the lowest acceptable address. This address must be a multiple of the allocation granularity returned by , or a multiple of the large page size returned by if large pages are being requested. If this member is NULL, then there is no lower limit. - Specifies the highest acceptable address (inclusive). This address must not exceed lpMaximumApplicationAddress returned by . Calling <a href=" and specifying NULL for LowestStartingAddress, and specifying NULL for HighestEndingAddress, gives the same behavior as calling /. + Specifies the highest acceptable address (inclusive). This address must not exceed lpMaximumApplicationAddress returned by . If this member is NULL, then there is no upper limit. Specifies power-of-2 alignment. Specifying 0 aligns the returned address on the system allocation granularity. diff --git a/sources/Interop/Windows/Windows/um/winnt/MEM_EXTENDED_PARAMETER.xml b/sources/Interop/Windows/Windows/um/winnt/MEM_EXTENDED_PARAMETER.xml index 591c6d9b38..6afe4797b1 100644 --- a/sources/Interop/Windows/Windows/um/winnt/MEM_EXTENDED_PARAMETER.xml +++ b/sources/Interop/Windows/Windows/um/winnt/MEM_EXTENDED_PARAMETER.xml @@ -10,20 +10,21 @@ A value that indicates the type of the parameter. If Type is set to MemExtendedParameterAddressRequirements, then Pointer must be a pointer to a caller-allocated structure that specifies the lowest and highest base address and alignment. - If Type is set to MemExtendedParameterNumaNode, then ULong must be set to the desired node number. + If Type is set to MemExtendedParameterNumaNode, then ULong64 must be set to the desired node number. + If Type is set to MemExtendedParameterAttributeFlags, then ULong64 must be set to a value that contains the desired flags: Reserved. - + + If Type is set to MemExtendedParameterNumaNode, then ULong64 must be set to the desired node number. + If Type is set to MemExtendedParameterAddressRequirements, then Pointer must be a pointer to a caller-allocated structure that specifies the lowest and highest base address and alignment. - - If Type is set to MemExtendedParameterNumaNode, then ULong must be set to the desired node number. - + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/winnt/MEM_EXTENDED_PARAMETER_TYPE.xml b/sources/Interop/Windows/Windows/um/winnt/MEM_EXTENDED_PARAMETER_TYPE.xml index 3af0931711..eb10cd43ca 100644 --- a/sources/Interop/Windows/Windows/um/winnt/MEM_EXTENDED_PARAMETER_TYPE.xml +++ b/sources/Interop/Windows/Windows/um/winnt/MEM_EXTENDED_PARAMETER_TYPE.xml @@ -14,6 +14,8 @@ - + + This extended parameter type is used to specify additional flags for new memory allocations created by and . + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/winnt/PROCESS_MITIGATION_SYSTEM_CALL_DISABLE_POLICY.xml b/sources/Interop/Windows/Windows/um/winnt/PROCESS_MITIGATION_SYSTEM_CALL_DISABLE_POLICY.xml index 3cc53ae77b..b202c18620 100644 --- a/sources/Interop/Windows/Windows/um/winnt/PROCESS_MITIGATION_SYSTEM_CALL_DISABLE_POLICY.xml +++ b/sources/Interop/Windows/Windows/um/winnt/PROCESS_MITIGATION_SYSTEM_CALL_DISABLE_POLICY.xml @@ -10,14 +10,55 @@ This member is reserved for system use. - + + When set to 1, the process is not permitted to perform GUI system calls. + - + -

- DisallowWin32kSystemCalls : 1

- When set to 1, the process is not permitted to perform GUI system calls. -

- ReservedFlags : 31

- This member is reserved for system use. + When set to 1, the process is not be able to successfully make NtFsControlFile system calls, with the following FsControlCode exceptions. + + + FSCTL_IS_VOLUME_MOUNTED + + + FSCTL_PIPE_IMPERSONATE + + + FSCTL_PIPE_LISTEN + + + FSCTL_PIPE_DISCONNECT + + + FSCTL_PIPE_TRANSCEIVE + + + FSCTL_PIPE_WAIT + + + FSCTL_PIPE_GET_PIPE_ATTRIBUTE + + + FSCTL_PIPE_GET_CONNECTION_ATTRIBUTE + + + FSCTL_PIPE_GET_HANDLE_ATTRIBUTE + + + FSCTL_PIPE_PEEK + + + FSCTL_PIPE_EVENT_SELECT + + + FSCTL_PIPE_EVENT_ENUM + + + + + This member is reserved for system use. + \ No newline at end of file diff --git a/sources/Interop/Windows/Windows/um/winnt/TOKEN_INFORMATION_CLASS.xml b/sources/Interop/Windows/Windows/um/winnt/TOKEN_INFORMATION_CLASS.xml index 6bd5675897..1bed538379 100644 --- a/sources/Interop/Windows/Windows/um/winnt/TOKEN_INFORMATION_CLASS.xml +++ b/sources/Interop/Windows/Windows/um/winnt/TOKEN_INFORMATION_CLASS.xml @@ -145,7 +145,12 @@ - + + + Refers to a Least Privileged AppContainer (LPAC). An LPAC is effectively an AppContainer that's disregarded by the ALL_APPLICATION_PACKAGES SID. For info about what an AppContainer is, see AppContainer for legacy apps. + Many resources across Windows are ACL'd with ALL_APPLICATION_PACKAGES, as described in DoNotAddAllApplicationPackagesToRestrictions. In scenarios where you want a process running with no rights to any resources except what you explicitly grant (for example, a web browser sandboxing a child worker process), an AppContaoiner has too much access to the system because of ALL_APPLICATION_PACKAGES. That's where an LPAC comes in. You can create an LPAC only imperatively via APIs; not declaratively via appxmanifest.xml. + + The maximum value for this enumeration. diff --git a/sources/Interop/Windows/Windows/um/winreg/Windows.xml b/sources/Interop/Windows/Windows/um/winreg/Windows.xml index db9596a151..ebafc918c3 100644 --- a/sources/Interop/Windows/Windows/um/winreg/Windows.xml +++ b/sources/Interop/Windows/Windows/um/winreg/Windows.xml @@ -2312,7 +2312,7 @@
- Note  Registry symbolic links should only be used for for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. + Note  Registry symbolic links should only be used for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. @@ -2477,7 +2477,7 @@
- Note  Registry symbolic links should only be used for for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. + Note  Registry symbolic links should only be used for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. @@ -2642,7 +2642,7 @@
- Note  Registry symbolic links should only be used for for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. + Note  Registry symbolic links should only be used for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. @@ -2807,7 +2807,7 @@
- Note  Registry symbolic links should only be used for for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. + Note  Registry symbolic links should only be used for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. @@ -2972,7 +2972,7 @@
- Note  Registry symbolic links should only be used for for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. + Note  Registry symbolic links should only be used for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. @@ -3137,7 +3137,7 @@
- Note  Registry symbolic links should only be used for for application compatibility when absolutely necessary.
This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path. + Note  Registry symbolic links should only be used for application compatibility when absolutely necessary.This key is a symbolic link. The target path is assigned to the L"SymbolicLinkValue" value of the key. The target path must be an absolute registry path.