Windows Deployment Services
Overview of the Windows Deployment Services technology.
To develop Windows Deployment Services, you need these headers:
For programming guidance for this technology, see:
Enumerations
| __unnamed_enum_1 The __unnamed_enum_1 (wdsclientapi.h) enumeration is used by the WdsCliLog function. |
| __unnamed_enum_2 The __unnamed_enum_2 (wdsclientapi.h) enumeration is used by the WdsCliLog function. |
| TRANSPORTCLIENT_CALLBACK_ID This enumeration is received by the WdsTransportClientRegisterCallback function. |
| TRANSPORTPROVIDER_CALLBACK_ID This structure is used by the WdsTransportServerRegisterCallback function. |
| WDSTRANSPORT_DIAGNOSTICS_COMPONENT_FLAGS Configures which WDS components have diagnostics enabled. WDS diagnostics log events to the system event log. |
| WDSTRANSPORT_DISCONNECT_TYPE Indicates what action a WDS client should take when it is disconnected from the session. |
| WDSTRANSPORT_FEATURE_FLAGS Indicates which WDS features are installed on the WDS server. |
| WDSTRANSPORT_IP_ADDRESS_SOURCE_TYPE Indicates the source from which the WDS multicast provider obtains a multicast address for a new session. |
| WDSTRANSPORT_IP_ADDRESS_TYPE Indicates the type of IP address. |
| WDSTRANSPORT_NAMESPACE_TYPE Determines the type of multicast sessions used for transmitting objects covered by this namespace. |
| WDSTRANSPORT_NETWORK_PROFILE_TYPE Defines settings that are used by WDS transport protocols to optimize data transfer on the network. |
| WDSTRANSPORT_PROTOCOL_FLAGS Specifies which protocols the WDS transport server supports. |
| WDSTRANSPORT_SERVICE_NOTIFICATION Specifies what action needs to be taken when notifying WDS transport services, such as rereading their settings following a configuration change. |
| WDSTRANSPORT_SLOW_CLIENT_HANDLING_TYPE Specifies the type of automatic actions a WDS transport server, running on Windows Server 2008 R2, should use to handle a client computer that is slowing the multicast transmission. |
| WDSTRANSPORT_TFTP_CAPABILITY Indicates which features are supported by the WDS TFTP server. |
| WDSTRANSPORT_UDP_PORT_POLICY Specifies which policy WDS transport services should use when allocating UDP ports. |
Functions
| Clone Copies the information from this namespace object into a new, unregistered namespace object in memory. |
| Commit Commits object data members to the underlying data store if the IWdsTransportCacheable::Dirty property has been set. Otherwise, the method returns with no action. |
| CreateNamespace Creates an object of an IWdsTransportNamespace interface that can be registered on the current WDS transport server. |
| Deregister Deregisters the namespace on the server. |
| DeregisterContentProvider Enables an application run on a client computer to deregister a content provider. This makes the provider no longer available for use by the WDS transport server. |
| DisableWdsTransportServices Sets all WDS transport services to Disabled mode. |
| Discard Discards all changes made to the object data members by clearing the IWdsTransportCacheable::Dirty property and then calling the object's IWdsTransportCacheable::Refresh method to reread the current object data. |
| Disconnect Disconnects the WDS client from the session and specifies what action the client should take upon disconnection. |
| DisconnectClient Disconnects a WDS client from a transport session and specifies what action the WDS client should take upon disconnection. |
| EnableWdsTransportServices Sets all WDS transport services to Auto-Start mode. |
| get__NewEnum Receives a pointer to an enumerator that can be used to iterate over the objects in this collection. |
| get_AutoDisconnectThreshold Sets or retrieves the threshold transmission rate, in kilobytes per second, used by the server. (Get) |
| get_BlockSize Retrieves the block size used in the TFTP session. |
| get_Components Enables a WDS client to configure which WDS transport components have event logging. (Get) |
| get_Configuration Sets or retrieves the configuration information for the content provider of the namespace. (Get) |
| get_ConfigurationManager Returns a pointer to the object of an IWdsTransportConfigurationManager interface used to manage the configuration of this server. |
| get_Content Receives a pointer to an object of the IWdsTransportContent interface that represents an active transport session on the WDS transport server. |
| get_ContentProvider Sets or retrieves the content provider for the namespace. (Get) |
| get_ContentProviders Receives a pointer to an instance of the IWdsTransportCollection interface. The collection contains objects of the IWdsTransportContentProvider interface for the content providers registered on the server. |
| get_Count Receives the number of objects in this collection. |
| get_CpuUtilization Receives the percentage of the WDS client’s CPU utilization. |
| get_CurrentFileOffset Receives the offset from the start of the file in bytes of the current block being transferred in the TFTP session. |
| get_Description Retrieves the description of the content provider. |
| get_Description Sets or retrieves the description of the namespace. (Get) |
| get_DiagnosticsPolicy Receives an interface pointer to the Configuration Manager's Diagnostics Policy object. The object can be used to configure diagnostics settings that WDS transport server components enable for diagnostic event logging. |
| get_Dirty Receives a value that indicates whether object data has been modified. |
| get_Enabled Receives or sets a value that enables a WDS client to configure diagnostic logging on the server. (Get) |
| get_EnableTftpVariableWindowExtension Receives a WDSTRANSPORT_TFTP_CAPABILITY value that specifies whether variable-window extension is enabled on the TFTP server. The value enables a WDS client computer to configure the WDS TFTP server to use variable-window extensions. (Get) |
| get_EndIpAddress Enables a WDS client computer to configure the end of a multicast IP address range for a specified type of IP address. (Get) |
| get_EndPort Enables a WDS client computer to configure the end of a UDP port range that is used by WDS transport services. (Get) |
| get_FileName Retrieves the name of the file being transferred in the TFTP session. |
| get_FilePath Retrieves the path to the content provider’s DLL. |
| get_FileSize Receives the size in bytes of the file being transferred. |
| get_FriendlyName Sets or retrieves the user-friendly name of the namespace. (Get) |
| get_Id Receives a unique client ID that identifies this WDS client on the WDS server. |
| get_Id Receives a unique content ID that identifies this content object on the server. |
| get_Id Receives the unique namespace ID for a namespace that has been registered on the server. |
| get_Id Receives a unique session ID that identifies this session on the server. |
| get_InitializationRoutine Retrieves the name of the method called to initialize the content provider. |
| get_InstalledFeatures Receives a value that indicates which WDS features are installed on the server. |
| get_IpAddress Receives a string value that contains the IP address of the WDS client. |
| get_IpAddress Receives a string value containing the client’s IP address. |
| get_IpAddressSource Enables a WDS client computer to configure, for a specified type of IP address, the IP address source from which the WDS transport server obtains a multicast address. (Get) |
| get_Item Receives a pointer to the object that matches the specified index. |
| get_JoinDuration Receives the time elapsed, in seconds, since the WDS client joined to the transport session. |
| get_MacAddress Receives the MAC address of the WDS client. |
| get_MasterClientId Receives a unique client ID assigned by the WDS server that identifies the master client for this session. |
| get_MemoryUtilization Receives the percentage of the WDS client’s memory in use. |
| get_MinimumClients Retrieves or sets a condition that starts transmission automatically. Transmission starts if the number of applications that have joined sessions reaches the value of this property. (Get) |
| get_MulticastSessionPolicy Receives an interface pointer to the Configuration Manager’s Multicast Session Policy object. This object can be used to configure multicast session parameters that are available beginning with Windows Server 2008 R2. |
| get_MultistreamStreamCount Receives the maximum number of multicast streams per transmission used by the server. (Get) |
| get_Name Receives the name of the WDS client on the WDS server. |
| get_Name Receives a pointer to a string value that contains the name of the data object represented by this content object. |
| get_Name Retrieves the name of the content provider. |
| get_Name Sets or retrieves the name of the namespace. (Get) |
| get_Name Returns the name of the server represented by this object. |
| get_Namespace Receives a pointer to an object of an IWdsTransportNamespace interface that represents the namespace associated with this content. |
| get_NamespaceManager Returns a pointer to the object of an IWdsTransportNamespaceManager interface used to manage namespaces on this server. |
| get_NetworkInterfaceAddress Receives the MAC address of the server network interface used by this transport session. |
| get_NetworkInterfaceName Receives the name of the server network interface used by this transport session. |
| get_NetworkProfile Enables a client computer to configure the network profile that is used by the WDS Transport Server. (Get) |
| get_NetworkUtilization Receives the percentage of the WDS client’s network bandwidth used. |
| get_PercentCompletion Receives the percentage of the current object that has been downloaded. |
| get_Protocols Receives a value that indicates which transport protocols are supported by the WDS server. |
| get_Registered Returns a value that indicates whether the namespace is registered on the server. |
| get_ServicePolicy Receives an interface pointer to the Configuration Manager's Service Policy object. This object can be used to configure service parameters such as the multicast IP address source and the active network profile. |
| get_Session Receives the transport session to which the WDS client is joined. |
| get_SetupManager Returns a pointer to the object of an IWdsTransportSetupManager interface used to manage the setup functionality on this server. |
| get_SlowClientFallback Receives a value that indicates the fallback policy requested by the server when automatically disconnecting slow clients from a multicast transmission. (Get) |
| get_SlowClientHandling Sets or retrieves a WDSTRANSPORT_SLOW_CLIENT_HANDLING_TYPE value that indicates the method used by the server to handle clients that are slowing down a multicast transmission. (Get) |
| get_StartIpAddress Enables a WDS client computer to configure the start of a multicast IP address range for a specified type of IP address. (Get) |
| get_StartPort Enables a WDS client computer to configure the start of a UDP port range that is used by WDS transport services. (Get) |
| get_StartTime Retrieves or sets a condition that starts transmission automatically. Transmission starts when the UTC time reaches the value of this property. (Get) |
| get_TftpCapabilities Receives a mask of WDSTRANSPORT_TFTP_CAPABILITY values that indicates which WDS TFTP features are supported by the WDS TFTP server. |
| get_TftpManager Receives a pointer to the object of the IWdsTransportTftpManager interface used to manage the WDS TFTP server. |
| get_TftpMaximumBlockSize Receives a value for the maximum block size used by the TFTP server. The value enables a WDS client computer to configure the maximum block size. (Get) |
| get_Timeout Receives the timeout in seconds used to communicate with the client. |
| get_Tombstoned Returns a value that indicates whether the server has saved the namespace object of a deregistered namespace in memory until all active sessions are completed or terminated. |
| get_TombstoneTime Returns the UTC date and time when the server saved the namespace object of a deregistered namespace. |
| get_TransferRate Receives the data transfer rate for this session in bytes per second. |
| get_TransmissionStarted Receives a value that indicates whether the server has started transmitting data under this namespace. |
| get_Type Enables an application to retrieve the type of the namespace for this object. |
| get_UdpPortPolicy Recieves the WDSTRANSPORT_UDP_PORT_POLICY value that specifies the UDP port allocation policy to be used by WDS transport services. The value enables a WDS client computer to configure the UDP port allocation policy. (Get) |
| get_UserIdentity Receives a string representing the user identity associated with this client. |
| get_Version Receives a value that indicates the operating system version of the WDS server. |
| get_WdsTransportServicesRunning Receives a value that indicates whether WDS transport services are running on the server. |
| get_WindowSize Receives the current window size being used in the TFTP session. The window size used during a TFTP session can be updated by the client through ACK packets when using the variable-window TFTP extension. |
| GetWdsTransportServer Creates an object of the IWdsTransportServer interface that can be used to manage a WDS transport server. The method confirms that the system can reach a WDS transport server with the specified name. |
| NotifyWdsTransportServices Sends a notification to WDS transport services. The notification value is translated to the appropriate WDS transport service controls, and then these controls are sent to the appropriate services. |
| PFN_WdsCliCallback Defines a callback function that WDS can call for progress notification and error messages during a file or image transfer. |
| PFN_WdsCliTraceFunction Defines a callback function that can receive debugging messages from the WDS client. |
| PFN_WdsTransportClientReceiveContents The PFN_WdsTransportClientReceiveContents callback is used by the multicast client to indicate that a block of data is ready to be used. |
| PFN_WdsTransportClientReceiveMetadata PFN_WdsTransportClientReceiveMetadata is an optional callback that a consumer may register to receive metadata type information about a file. This information is provided by the content provider and is opaque to the multicast client and server. |
| PFN_WdsTransportClientSessionComplete The PFN_WdsTransportClientSessionCompete callback is used by the client to indicate that no more callbacks will be sent to the consumer and that the session either completed successfully or encountered a non-recoverable error. |
| PFN_WdsTransportClientSessionStart The PFN_WdsTransportClientSessionStart callback is called at the start of a multicast session to indicate file size and other server side information about the file to the consumer. (PFN_WdsTransportClientSessionStart) |
| PFN_WdsTransportClientSessionStartEx The PFN_WdsTransportClientSessionStart callback is called at the start of a multicast session to indicate file size and other server side information about the file to the consumer. (PFN_WdsTransportClientSessionStartEx) |
| put_AutoDisconnectThreshold Sets or retrieves the threshold transmission rate, in kilobytes per second, used by the server. (Put) |
| put_Components Enables a WDS client to configure which WDS transport components have event logging. (Put) |
| put_Configuration Sets or retrieves the configuration information for the content provider of the namespace. (Put) |
| put_ContentProvider Sets or retrieves the content provider for the namespace. (Put) |
| put_Description Sets or retrieves the description of the namespace. (Put) |
| put_Enabled Receives or sets a value that enables a WDS client to configure diagnostic logging on the server. (Put) |
| put_EnableTftpVariableWindowExtension Receives a WDSTRANSPORT_TFTP_CAPABILITY value that specifies whether variable-window extension is enabled on the TFTP server. The value enables a WDS client computer to configure the WDS TFTP server to use variable-window extensions. (Put) |
| put_EndIpAddress Enables a WDS client computer to configure the end of a multicast IP address range for a specified type of IP address. (Put) |
| put_EndPort Enables a WDS client computer to configure the end of a UDP port range that is used by WDS transport services. (Put) |
| put_FriendlyName Sets or retrieves the user-friendly name of the namespace. (Put) |
| put_IpAddressSource Enables a WDS client computer to configure, for a specified type of IP address, the IP address source from which the WDS transport server obtains a multicast address. (Put) |
| put_MinimumClients Retrieves or sets a condition that starts transmission automatically. Transmission starts if the number of applications that have joined sessions reaches the value of this property. (Put) |
| put_MultistreamStreamCount Receives the maximum number of multicast streams per transmission used by the server. (Put) |
| put_Name Sets or retrieves the name of the namespace. (Put) |
| put_NetworkProfile Enables a client computer to configure the network profile that is used by the WDS Transport Server. (Put) |
| put_SlowClientFallback Receives a value that indicates the fallback policy requested by the server when automatically disconnecting slow clients from a multicast transmission. (Put) |
| put_SlowClientHandling Sets or retrieves a WDSTRANSPORT_SLOW_CLIENT_HANDLING_TYPE value that indicates the method used by the server to handle clients that are slowing down a multicast transmission. (Put) |
| put_StartIpAddress Enables a WDS client computer to configure the start of a multicast IP address range for a specified type of IP address. (Put) |
| put_StartPort Enables a WDS client computer to configure the start of a UDP port range that is used by WDS transport services. (Put) |
| put_StartTime Retrieves or sets a condition that starts transmission automatically. Transmission starts when the UTC time reaches the value of this property. (Put) |
| put_TftpMaximumBlockSize Receives a value for the maximum block size used by the TFTP server. The value enables a WDS client computer to configure the maximum block size. (Put) |
| put_UdpPortPolicy Recieves the WDSTRANSPORT_UDP_PORT_POLICY value that specifies the UDP port allocation policy to be used by WDS transport services. The value enables a WDS client computer to configure the UDP port allocation policy. (Put) |
| PxeAsyncRecvDone Passes the results of processing the client request asynchronously. This function should be called only if the PxeProviderRecvRequest function returns ERROR_IO_PENDING. |
| PxeDhcpAppendOption Appends a DHCP option to the reply packet. (PxeDhcpAppendOption) |
| PxeDhcpAppendOptionRaw Appends a DHCP option to the reply packet. (PxeDhcpAppendOptionRaw) |
| PxeDhcpGetOptionValue Retrieves an option value from a DHCP packet. |
| PxeDhcpGetVendorOptionValue Retrieves an option value from the Vendor Specific Information field (43) of a DHCP packet. |
| PxeDhcpInitialize Initializes a response packet as a DHCP reply packet. |
| PxeDhcpIsValid Validates that a packet is a DHCP packet. |
| PxeDhcpv6AppendOption Appends a DHCPv6 option to the reply packet. (PxeDhcpv6AppendOption) |
| PxeDhcpv6AppendOptionRaw Appends a DHCPv6 option to the reply packet. (PxeDhcpv6AppendOptionRaw) |
| PxeDhcpv6CreateRelayRepl Generates a RELAY-REPL message. |
| PxeDhcpv6GetOptionValue Retrieves an option value from a DHCPv6 packet. |
| PxeDhcpv6GetVendorOptionValue Retrieves option values from the OPTION_VENDOR_OPTS (17) field of a DHCPv6 packet. |
| PxeDhcpv6Initialize Initializes a response packet as a DHCPv6 reply packet. |
| PxeDhcpv6IsValid Validates that a packet is a valid DHCPv6 packet. |
| PxeDhcpv6ParseRelayForw This function can be used by a provider to parse RELAY-FORW messages and their nested OPTION_RELAY_MSG messages. |
| PxeGetServerInfo Returns information about the PXE server. (PxeGetServerInfo) |
| PxeGetServerInfoEx Returns information about the PXE server. (PxeGetServerInfoEx) |
| PxePacketAllocate Allocates a packet to be sent with the PxeSendReply function. |
| PxePacketFree Frees a packet allocated by the PxePacketAllocate function. |
| PxeProviderEnumClose Closes the enumeration of providers opened by the PxeProviderEnumFirst function. |
| PxeProviderEnumFirst Starts an enumeration of registered providers. |
| PxeProviderEnumNext Enumerates registered providers. |
| PxeProviderFreeInfo Frees memory allocated by the PxeProviderEnumNext function. |
| PxeProviderQueryIndex Returns the index of the specified provider in the list of registered providers. |
| PxeProviderRegister Registers a provider with the system. |
| PxeProviderSetAttribute Specifies attributes for the provider. |
| PxeProviderUnRegister Removes a provider from the list of registered providers. |
| PxeRegisterCallback Registers callback functions for different notification events. |
| PxeSendReply Sends a packet to a client request. |
| PxeTrace Adds a trace entry to the PXE log. |
| Refresh Refreshes the object data members by rereading their values from the underlying data store. This is allowed only if the object's IWdsTransportCacheable::Dirty property has been set. |
| Refresh Resets the property values of the namespace with values from the server. |
| Register Registers the namespace on the server. |
| RegisterContentProvider Enables an application run on a client computer to register a content provider DLL. This makes the provider available for use by the WDS transport server. |
| RestartWdsTransportServices Stops and then restarts any WDS transport services that are running. If no services are running, the method returns with S_OK without further action. |
| RetrieveClients Retrieves a collection of WDS clients joined to the transport session. |
| RetrieveContents Retrieves a collection of active transport content objects associated with the namespace. |
| RetrieveNamespace Retrieves, by name, an object of an IWdsTransportNamespace interface. The name should be registered with the namespace on the WDS transport server. |
| RetrieveNamespaces Returns a collection of objects of the IWdsTransportNamespace interface that represent namespaces on the server that match specified criteria. |
| RetrieveSessions Retrieves a collection of active transport sessions associated with this content. |
| RetrieveTftpClients Returns a pointer to the object of an IWdsTransportCollection interface containing a collection of objects of the IWdsTransportTftpClient interface for the clients currently connected to the TFTP server. |
| StartTransmission Starts a transmission on a namespace. |
| StartWdsTransportServices Starts all WDS transport services. This method provides the means to change the running state of WDS transport services without changing their configuration. |
| StopWdsTransportServices Stops all WDS transport services. This method provides the means to change the running state of WDS transport services without changing their configuration. |
| Terminate Terminates the transmission of this content by terminating all active sessions under the content and disconnecting any clients that are joined to them. |
| Terminate Terminates an active session on the WDS transport server and disconnects all WDS clients joined to the session. |
| WdsBpAddOption Adds an option to the packet. |
| WdsBpCloseHandle Closes the specified handle. |
| WdsBpGetOptionBuffer Copies information into a buffer that should be added to your DHCP packet options. |
| WdsBpInitialize Constructs options for the WDS network boot program. |
| WdsBpParseInitialize Receives a handle to the packet sent by the network boot program. (WdsBpParseInitialize) |
| WdsBpParseInitializev6 Receives a handle to the packet sent by the network boot program. (WdsBpParseInitializev6) |
| WdsBpQueryOption Returns the value of an option from the parsed packet. |
| WdsCliAuthorizeSession Converts a session with a WDS server into an authenticated session. |
| WdsCliCancelTransfer Cancels a WDS transfer operation. |
| WdsCliClose Closes a handle to a WDS session or image, and releases resources. |
| WdsCliCreateSession Starts a new session with a WDS server. |
| WdsCliFindFirstImage Starts the enumeration of images stored on a WDS server and returns a find handle that references the first image. |
| WdsCliFindNextImage Advances the reference of a find handle to the next image stored on a WDS server. |
| WdsCliFreeStringArray This function can be used to free the array of string values that gets allocated by the WdsCliObtainDriverPackages function. |
| WdsCliGetDriverQueryXml This function generates an XML string which can be used to query a WDS server for driver packages using the WdsCliObtainDriverPackagesEx function. |
| WdsCliGetEnumerationFlags Returns the image enumeration flag for the current image handle. |
| WdsCliGetImageArchitecture Returns the processor architecture for the current image. |
| WdsCliGetImageDescription Returns a description of the current image. |
| WdsCliGetImageGroup Returns the name of the image group for the current image. |
| WdsCliGetImageHalName Returns the Hardware Abstraction Layer (HAL) name for the current image. |
| WdsCliGetImageHandleFromFindHandle Returns an image handle for the current image in an image enumeration. |
| WdsCliGetImageHandleFromTransferHandle Returns an image handle from a completed transfer handle. The handle is to the local copy of the image that's been transferred from the server to the client. |
| WdsCliGetImageIndex Returns the index within the Windows Imaging Format(WIM) file for the current image. |
| WdsCliGetImageLanguage Returns the default language of the current image. |
| WdsCliGetImageLanguages Returns an array of languages supported by the current image. |
| WdsCliGetImageLastModifiedTime Returns the last-modification time of the current image. |
| WdsCliGetImageName Returns the name of the current image. |
| WdsCliGetImageNamespace Returns the namespace of the current image. |
| WdsCliGetImagePath Returns the path to the file that contains the current image. |
| WdsCliGetImageSize Returns the size of the current image. |
| WdsCliGetImageVersion Returns the version of the current image. |
| WdsCliGetTransferSize Returns the size of the current file transfer. |
| WdsCliInitializeLog Initializes logging for the WDS client. |
| WdsCliLog Sends a log event to the WDS server. |
| WdsCliObtainDriverPackages This function obtains from a WDS image, the driver packages (INF files) that can be used on this computer. |
| WdsCliObtainDriverPackagesEx This function obtains the driver packages (INF files) that are applicable to the specified WDS driver query XML. |
| WdsCliRegisterTrace Registers a callback function that will receive debugging messages. |
| WdsCliTransferFile Transfers a file from a WDS server to the WDS client using a multicast transfer protocol. |
| WdsCliTransferImage Transfers an image from a WDS server to the WDS client. |
| WdsCliWaitForTransfer Waits for an image or file transfer to complete. |
| WdsTransportClientAddRefBuffer Increments the reference count on a buffer owned by the multicast client. |
| WdsTransportClientCancelSession Releases the resources associated with a session in the client. (WdsTransportClientCancelSession) |
| WdsTransportClientCloseSession Releases the resources associated with a session in the client. (WdsTransportClientCloseSession) |
| WdsTransportClientCompleteReceive Indicates that all processing on a block of data is finished, and that the multicast client may purge this block of data from its cache to make room for further receives. |
| WdsTransportClientInitialize Initializes the Multicast Client. |
| WdsTransportClientInitializeSession Initiates a multicast file transfer. (WdsTransportClientInitializeSession) |
| WdsTransportClientQueryStatus Retrieves the current status of an ongoing or complete multicast transmission from the multicast client. |
| WdsTransportClientRegisterCallback Registers a callback with the multicast client. |
| WdsTransportClientReleaseBuffer Decrements the reference count on a buffer owned by the multicast client. |
| WdsTransportClientShutdown Shuts down the multicast client. |
| WdsTransportClientStartSession Initiates a multicast file transfer. (WdsTransportClientStartSession) |
| WdsTransportClientWaitForCompletion Blocks until either the multicast session is complete or the specified timeout is reached. |
| WdsTransportProviderCloseContent Closes a content stream specified by a handle. |
| WdsTransportProviderCloseInstance Closes an instance of a content provider specified by a handle. |
| WdsTransportProviderCompareContent Compares a specified content name and instance to an open content stream to determine if they are the same. |
| WdsTransportProviderCreateInstance Opens a new instance of a content provider. |
| WdsTransportProviderDumpState Instructs the transport provider to print a summary of its state and any other relevant information to the tracing log. |
| WdsTransportProviderGetContentMetadata Retrieves metadata for an open content stream. |
| WdsTransportProviderGetContentSize Retrieves the size of an open content stream. |
| WdsTransportProviderInitialize Initializes a content provider. |
| WdsTransportProviderOpenContent Opens a new static view of a content stream. |
| WdsTransportProviderReadContent Reads content from an open content stream. |
| WdsTransportProviderRefreshSettings Instructs the transport provider to reread any relevant settings. |
| WdsTransportProviderShutdown Shuts down the content provider. |
| WdsTransportProviderUserAccessCheck Specifies access to a content stream based on a user's token. |
| WdsTransportServerAllocateBuffer Allocates a buffer in memory. |
| WdsTransportServerCompleteRead Provides status of read operation. |
| WdsTransportServerFreeBuffer Releases memory used by a buffer. |
| WdsTransportServerRegisterCallback Registers a provider callback with the multicast server. |
| WdsTransportServerTrace Sends a debugging message. (WdsTransportServerTrace) |
| WdsTransportServerTraceV Sends a debugging message. (WdsTransportServerTraceV) |
Interfaces
| IWdsTransportCacheable Provides caching for objects that handle persistent data. This interface can be inherited by other interfaces that represent persisted objects. |
| IWdsTransportClient Represents a WDS client that is joined to a transport session on a WDS transport server. |
| IWdsTransportCollection Represents a collection of Windows Deployment Services (WDS) transport management objects. |
| IWdsTransportConfigurationManager Manages the configuration of a WDS transport server. |
| IWdsTransportConfigurationManager2 This interface inherits from the IWdsTransportConfigurationManager interface and extends it with configuration settings, such as multicast session policy, that are available beginning with Windows Server 2008 R2. |
| IWdsTransportContent Represents content being transmitted under a namespace over one or more sessions. |
| IWdsTransportContentProvider Used to describe a content provider. |
| IWdsTransportDiagnosticsPolicy Represents the diagnostics policy part of the WDS transport server's configuration. |
| IWdsTransportManager Manages a WDS transport server. This is the top-level interface into the Windows Deployment Services (WDS) Transport Management API and the only interface that can be created using the CoCreateInstance function. |
| IWdsTransportMulticastSessionPolicy This interface represents the multicast session policy portion of a WDS Transport server’s configuration. |
| IWdsTransportNamespace Represents a namespace on a WDS transport server. |
| IWdsTransportNamespaceAutoCast The WDS transport server can create, start, and end multicast sessions that are hosted by a namespace object of this interface. |
| IWdsTransportNamespaceManager Manages namespaces on a WDS transport server. |
| IWdsTransportNamespaceScheduledCast Represents a base interface to the derived interfaces:_IWdsTransportNamespaceScheduledCastManualStart and IWdsTransportNamespaceScheduledCastAutoStart. |
| IWdsTransportNamespaceScheduledCastAutoStart An administrator can specify criteria that starts transmission on an object of an IWdsTransportNamespaceScheduledCastAutoStart interface automatically. Applications can continue to join sessions of the namespace object until these criteria are reached. |
| IWdsTransportNamespaceScheduledCastManualStart An administrator must start transmission on an object of an IWdsTransportNamespaceScheduledCastManualStart interface. Applications can continue to join sessions of the namespace until the administrator starts transmission. |
| IWdsTransportServer Represents a WDS transport server. A WDS client can use an object of this interface to manage setup, configuration, and namespace tasks on the server. |
| IWdsTransportServer2 This interface inherits from the IWdsTransportServer interface and extends it. It is available beginning with Windows Server 2012. |
| IWdsTransportServicePolicy Represents the service policy part of the WDS transport server's configuration. |
| IWdsTransportServicePolicy2 This interface inherits from the IWdsTransportServicePolicy interface and extends it beginning with Windows Server 2012. |
| IWdsTransportSession Represents an active transport session on the WDS transport server. |
| IWdsTransportSetupManager Manages setup tasks on a WDS transport server. |
| IWdsTransportSetupManager2 This interface inherits from the IWdsTransportSetupManager interface and extends it. It is available beginning with Windows Server 2012. |
| IWdsTransportTftpClient This interface is used to specify information of a TFTP client session currently active in the server. |
| IWdsTransportTftpManager This interface provides a method to retrieve all the clients currently connected to the TFTP server. |
Structures
| PXE_ADDRESS Specifies the network address for a packet. |
| PXE_DHCP_MESSAGE The PXE_DHCP_MESSAGE structure can be used with the Windows Deployment Services PXE Server API. |
| PXE_DHCP_OPTION The PXE_DHCP_OPTION structure can be used with the Windows Deployment Services PXE Server API. |
| PXE_DHCPV6_MESSAGE A DHCPV6 message. |
| PXE_DHCPV6_MESSAGE_HEADER Describes the fields in common between the PXE_DHCPV6_MESSAGE and PXE_DHCPV6_RELAY_MESSAGE structures. |
| PXE_DHCPV6_NESTED_RELAY_MESSAGE Describes packets nested in OPTION_RELAY_MSG message. |
| PXE_DHCPV6_OPTION The PXE_DHCPV6_OPTION structure can be used with the Windows Deployment Services PXE Server API. |
| PXE_DHCPV6_RELAY_MESSAGE Provides the DHCPV6 relay message. |
| PXE_PROVIDER Describes a provider. |
| TRANSPORTCLIENT_SESSION_INFO This structure is used by the PFN_WdsTransportClientSessionStartEx callback function. |
| WDS_CLI_CRED Contains credentials used to authorize a client session. |
| WDS_TRANSPORTCLIENT_REQUEST This structure is used by the WdsTransportClientStartSession function. |
| WDS_TRANSPORTPROVIDER_INIT_PARAMS This structure is used by the WdsTransportProviderInitialize callback function. (WDS_TRANSPORTPROVIDER_INIT_PARAMS) |
| WDS_TRANSPORTPROVIDER_SETTINGS This structure is used by the WdsTransportProviderInitialize callback function. (WDS_TRANSPORTPROVIDER_SETTINGS) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for