RemoveByName method of the MSFT_OdbcDsnTask class

Removes one or more existing DSNs from the system.

Syntax


uint32 RemoveByName(
  [in]  boolean      PassThru,
  [in]  string       Name,
  [in]  string       DriverName,
  [in]  string       Platform,
  [in]  string       DsnType,
  [out] MSFT_OdbcDsn cmdletOutput[]
);

Parameters

PassThru [in]

Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.

Name [in]

Specifies one or more ODBC DSNs to remove. You can use wildcard characters.

DriverName [in]

This cmdlet will remove the ODBC DSN using this driver only. You can use wildcard characters. The default is to remove all ODBC DSNs.

Platform [in]

The platform architecture of the ODBC DSN to remove. Possible values are '32-bit', '64-bit' or 'All'. The default is '32-bit' on a 32-bit process and '64-bit' on a 64-bit process. This is the platform architecture on the remote machine if this command is executed in a remote CIM session.

DsnType [in]

The type of the ODBC DSN to remove. Possible values are 'User', 'System' or 'All'.

cmdletOutput [out]

The output is an array of CIM objects of type MSFT_OdbcDsn, each of which represents an ODBC DSN.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

Root\Microsoft\Windows\WDAC

MOF

WdacWmiProv.mof

DLL

WdacWmiProv.dll

See also

MSFT_OdbcDsnTask
MSFT_OdbcDsn

 

 

Show: