ExternalFileFormat Class

 

Represents the external file format.

Namespace:   Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)


public ref class ExternalFileFormat sealed : NamedSmoObject, 
	ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, 
	IScriptable

NameDescription
System_CAPS_pubmethodExternalFileFormat()

Initializes a new instance of the ExternalFileFormat class.

System_CAPS_pubmethodExternalFileFormat(Database^, String^)

Initializes a new instance of the ExternalFileFormat class.

System_CAPS_pubmethodExternalFileFormat(Database^, String^, ExternalFileFormatType)

Initializes a new instance of the ExternalFileFormat class.

NameDescription
System_CAPS_pubpropertyDataCompression

Gets or sets the data compression for the external file format.

System_CAPS_pubpropertyDateFormat

Gets or sets the format of the date.

System_CAPS_pubpropertyEncoding

Gets the encoding of the file.

System_CAPS_pubpropertyExecutionManager

Gets the object to execute to the manager.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyFieldTerminator

Gets or sets the field terminator for use in char and widechar data files.

System_CAPS_pubpropertyFormatType

Gets or sets the format type of the external file format.

System_CAPS_pubpropertyID

Gets the value of the id.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyParent

Gets or sets the parent of the object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyRowTerminator

Gets the RowTerminator for the specific file format.

System_CAPS_pubpropertySerDeMethod

Gets or sets the serialize deprecated method for the external file format.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyStringDelimiter

Gets or sets the string delimiter of the external file format.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUseTypeDefault

Gets or sets a value that indicates whether the file uses default format type.

NameDescription
System_CAPS_pubmethodCreate()

Creates a file with a specific format.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, String^)

Denies the specified set of permissions for the external file format object.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, String^, Boolean)

Denies the specified permission for the specified grantees on the ExternalFileFormat.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, array<String^>^)

Denies the specified set of permissions for the specified grantee on the ExternalFileFormat.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, array<String^>^, Boolean)

Denies the permission for the object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the external file format object.

System_CAPS_pubmethodDropIfExists()

Drops a ExternalFileFormat object if exists in the server.

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of permissions for objects in the external file.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet^)

Enumerates a list of object permissions for a specified permission on the external file format.

System_CAPS_pubmethodEnumObjectPermissions(String^)

Enumerates the list of object permission for the external file format.

System_CAPS_pubmethodEnumObjectPermissions(String^, ObjectPermissionSet^)

Enumerates a list of object permissions for a specified grantee and a specified permission on the SMO object.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object^)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet^, String^)

Grants access to the specified permission for the specified grantee on the external file format object.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, String^, Boolean)

Grants permission to the specified object.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, String^, Boolean, String^)

Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the SMO object.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, array<String^>^)

Grants the specified set of permissions to the specified grantee on the ExternalFileFormat.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, array<String^>^, Boolean)

Grants access to the specified permission for the specified grantee on the ExternalFileFormat.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, array<String^>^, Boolean, String^)

Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the external file under an assumed role.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String^)

Determines whether the specified property is supported in the target .NET Framework.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, String^)

Revokes previously granted permission from a grantee on the SMO object.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, String^, Boolean, Boolean)

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, String^, Boolean, Boolean, String^)

Revokes the specified set of permissions to the grantees and the ability to revoke the set of permissions to other file format.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, array<String^>^)

Revokes previously granted permission from a list of grantees on the SMO object.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, array<String^>^, Boolean, Boolean)

Revokes an object for the permission.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, array<String^>^, Boolean, Boolean, String^)

Revokes the permission.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the SMO object.

System_CAPS_pubmethodScript(ScriptingOptions^)

Generates a Transact-SQL script that can be used to re-create the SMO object as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject^)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String^, array<Object^>^)

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyType(String^)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyValue(String^, Type^)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetUrn()

Gets the Unified Resource Name (URN) of the object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::Resolve(String^)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetPropertyValue(String^, Type^, Object^)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider::GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode::IsDesignMode

Gets a value that indicates whether the object supports design mode.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: