INetCfgComponent::GetBindName method
The GetBindName method retrieves the description of a network component that the network configuration subsystem uses for binding operations.
Syntax
HRESULT GetBindName(
[out] LPWSTR *ppszwBindName
);
Parameters
- ppszwBindName [out]
Pointer to a buffer that receives a constant null-terminated string of 16-bit Unicode characters containing the description of a network component used for binding operations.
Return value
Returns zero (S_OK) if successful; otherwise, returns NETCFG_* codes that are defined in Netcfgx.h. If the ppszwBindName parameter is NULL, GetBindName returns E_POINTER.
Remarks
After notify objects call GetBindName to retrieve the description of a network component used for binding operations, GetBindName allocates the memory required to store the string containing the description. After notify objects finish with the description, they must call the COM CoTaskMemFree function to release the memory. For more information about CoTaskMemFree, see the Microsoft Windows SDK.
A notify object can call the following methods to retrieve and traverse bindings in search of a network component with a specific bind name:
QueryInterface method of INetCfgComponent to obtain a pointer to INetCfgComponentBindings
Methods of the IEnumNetCfgBindingPath interface that enumerate the INetCfgBindingPath interfaces
Methods of the IEnumNetCfgBindingInterface interface that enumerate the INetCfgBindingInterface interfaces
INetCfgBindingInterface::GetUpperComponent and INetCfgBindingInterface::GetLowerComponent
GetBindName to retrieve the component's bind name
Strings that contain descriptions of network components used for binding operations can include "tcpip", "netbios", and "ndiswanipout."
Requirements
Target platform |
Desktop |
Header |
Netcfgx.h (include Netcfgx.h) |
See also
INetCfgBindingInterface::GetLowerComponent
INetCfgBindingInterface::GetUpperComponent
INetCfgBindingPath::EnumBindingInterfaces
INetCfgComponentBindings::EnumBindingPaths