sp_OAGetProperty (Transact-SQL)

Se aplica a:SQL Server

Obtiene el valor de una propiedad de un objeto OLE.

Convenciones de sintaxis de Transact-SQL

Sintaxis

  
sp_OAGetProperty objecttoken , propertyname   
    [ , propertyvalue OUTPUT ]  
    [ , index...]   

Argumentos

objecttoken
Es el token de objeto de un objeto OLE que se creó anteriormente mediante sp_OACreate.

propertyname
Es el nombre de la propiedad del objeto OLE que se devolverá.

propertyvalueOUTPUT
Es el valor devuelto de la propiedad. Si se especifica, debe ser una variable local del tipo de datos adecuado.

Si la propiedad devuelve un objeto OLE, propertyvalue debe ser una variable local de tipo de datos int. Un token de objeto se almacena en la variable local y este token de objeto se puede usar con otros procedimientos almacenados de OLE Automation.

Si la propiedad devuelve un valor único, especifique una variable local para propertyvalue, que devuelve el valor de propiedad en la variable local; o no especifique propertyvalue, que devuelve el valor de propiedad al cliente como un conjunto de resultados de una sola columna y fila única.

Cuando la propiedad devuelve una matriz, si se especifica propertyvalue , se establece en NULL.

Si se especifica propertyvalue , pero la propiedad no devuelve un valor, se produce un error. Si la propiedad devuelve una matriz con más de dos dimensiones, se produce un error.

índice
Es un parámetro de índice. Si se especifica, index debe ser un valor del tipo de datos adecuado.

Algunas propiedades tienen parámetros. Estas propiedades se llaman propiedades indizadas y los parámetros se llaman parámetros de índice. Una propiedad puede tener varios parámetros de índice.

Nota:

Los parámetros de este procedimiento almacenado se especifican por posición, no por nombre.

Valores de código de retorno

0 (correcto) o un valor distinto de cero (error) que es el valor entero del HRESULT devuelto por el objeto de OLE Automation.

Para obtener más información sobre los códigos de retorno HRESULT, vea Códigos de retorno y información de error de OLE Automation.

Conjuntos de resultados

Si la propiedad devuelve una matriz con una o dos dimensiones, la matriz se devuelve al cliente como un conjunto de resultados:

• Se devuelve al cliente una matriz unidimensional como conjunto de resultados de fila única con tantas columnas como elementos tenga la matriz. En otras palabras, la matriz se devuelve como columnas.

• Se devuelve al cliente una matriz bidimensional como conjunto de resultados con tantas columnas como elementos haya en la primera dimensión de la matriz y con tantas filas como elementos haya en la segunda dimensión de la matriz. En otras palabras, la matriz se devuelve como (columnas, filas).

Cuando un valor devuelto de propiedad o un valor devuelto de método es una matriz, sp_OAGetProperty o sp_OAMethod devuelve un conjunto de resultados al cliente. (Los parámetros de salida del método no pueden ser matrices). Estos procedimientos examinan todos los valores de datos de la matriz para determinar los tipos de datos y las longitudes de datos de SQL Server adecuados que se usarán para cada columna del conjunto de resultados. Para una columna determinada, estos procedimientos utilizan el tipo y la longitud de datos necesarios para representar todos los valores de los datos de la columna.

Cuando todos los valores de datos de una columna comparten el mismo tipo de datos, se utiliza ese tipo para toda la columna. Cuando los valores de datos de una columna utilizan tipos de datos diferentes, el tipo de datos de toda la columna se elige como se muestra a continuación.

	int	FLOAT	money	datetime	varchar	nvarchar
int	int	float	money	varchar	varchar	nvarchar
float	float	float	money	varchar	varchar	nvarchar
money	money	money	money	varchar	varchar	nvarchar
datetime	varchar	varchar	varchar	datetime	varchar	nvarchar
varchar	varchar	varchar	varchar	varchar	varchar	nvarchar
nvarchar	nvarchar	nvarchar	nvarchar	nvarchar	nvarchar	nvarchar

Comentarios

También puede usar sp_OAMethod para obtener un valor de propiedad.

Permisos

Requiere la pertenencia al rol fijo de servidor sysadmin o ejecutar el permiso directamente en este procedimiento almacenado. Ole Automation Procedures la configuración debe estar habilitada para usar cualquier procedimiento del sistema relacionado con OLE Automation.

Ejemplos

A Usar una variable local

En el ejemplo siguiente se obtiene la HostName propiedad (del objeto SQLServer creado anteriormente) y se almacena en una variable local.

DECLARE @property varchar(255);  
EXEC @hr = sp_OAGetProperty @object, 'HostName', @property OUT;  
IF @hr <> 0  
BEGIN  
   EXEC sp_OAGetErrorInfo @object  
    RETURN  
END  
PRINT @property;  

B. Usar un conjunto de resultados

En el ejemplo siguiente se obtiene la HostName propiedad (del objeto SQLServer creado anteriormente) y se devuelve al cliente como un conjunto de resultados.

EXEC @hr = sp_OAGetProperty @object, 'HostName';  
IF @hr <> 0  
BEGIN  
   EXEC sp_OAGetErrorInfo @object  
    RETURN  
END;  

Consulte también

Procedimientos almacenados de OLE Automation (Transact-SQL)
Ejemplo de script de automatización OLE