Método IAccessible::get_accDefaultAction (oleacc.h)

Artículo
08/25/2023

El método IAccessible::get_accDefaultAction recupera una cadena que indica la acción predeterminada del objeto. No todos los objetos tienen una acción predeterminada.

Sintaxis

HRESULT get_accDefaultAction(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszDefaultAction
);

Parámetros

[in] varChild

Tipo: VARIANT

Especifica si el objeto o uno de los elementos secundarios del objeto realiza la acción predeterminada recuperada. Este parámetro es CHILDID_SELF (para obtener información sobre el objeto) o un identificador secundario (para obtener información sobre el elemento secundario del objeto). Para obtener más información sobre cómo inicializar la estructura VARIANT, vea Cómo se usan los identificadores secundarios en parámetros.

[out, retval] pszDefaultAction

Tipo: BSTR*

Dirección de un BSTR que recibe una cadena localizada que describe la acción predeterminada para el objeto especificado; si este objeto no tiene ninguna acción predeterminada, el valor es NULL.

Valor devuelto

Tipo: HRESULT

Si se ejecuta correctamente, devuelve S_OK.

Si no se ejecuta correctamente, devuelve uno de los valores de la tabla siguiente u otro código de error COM estándar. Los servidores devuelven estos valores, pero los clientes siempre deben comprobar los parámetros de salida para asegurarse de que contienen valores válidos. Para obtener más información, vea Comprobar valores devueltos de IAccessible.

Error	Descripción
S_FALSE	El objeto especificado no tiene una acción predeterminada.
E_INVALIDARG	Un argumento no es válido.
DISP_E_MEMBERNOTFOUND	El objeto especificado no admite esta propiedad.

Comentarios

La cadena recuperada describe la acción que se realiza en un objeto, no lo que hace el objeto como resultado. Por ejemplo, un botón de barra de herramientas que imprime un documento tiene una acción predeterminada de "Presionar" en lugar de "Imprime el documento actual".

No confunda la acción predeterminada de un objeto con su valor. Para obtener más información, vea DefaultAction (propiedad).

Solo los controles que realizan acciones admiten este método.

Nota para los desarrolladores de servidores: Localizar la cadena devuelta de esta propiedad.

Ejemplo de servidor

En el código de ejemplo siguiente se muestra una posible implementación de este método para un cuadro de lista personalizado. Por motivos de simplicidad, las cadenas no se localizan.


HRESULT STDMETHODCALLTYPE AccServer::get_accDefaultAction( 
    VARIANT varChild,
    BSTR *pszDefaultAction)
{
    if (varChild.vt != VT_I4)
    {
        *pszDefaultAction = NULL;
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszDefaultAction = SysAllocString(L"None.");
    }
    else
    {
        *pszDefaultAction = SysAllocString(L"Double-click");
    }
    return S_OK;
};

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	oleacc.h
Library	Oleacc.lib
Archivo DLL	Oleacc.dll
Redistribuible	RDK de accesibilidad activa 1.3 en Windows NT 4.0 con SP6 y versiones posteriores y Windows 95