Compartilhar via


xlSheetNm

Aplica-se a: Excel 2013 | Office 2013 | Visual Studio

Retorna o nome de uma planilha ou planilha de macro de sua ID de planilha interna contida em uma referência externa ou o nome da planilha atual se aprovada uma referência interna.

Excel12(xlSheetNm, LPXLOPER12 pxRes, 1, LPXLOPER12 pxExtref);

Parâmetros

pxExtref (xltypeRef ou xltypeSRef)

Uma referência à planilha cujo nome você deseja.

Se você estiver passando uma referência externa (xltypeRef), ela só precisará conter a ID da planilha. As estruturas de dados que descrevem as células na planilha são ignoradas e não precisam ser fornecidas. Se a ID estiver definida como zero, xlSheetNm retornará o nome da planilha atual.

Se você estiver passando uma referência interna (xltypeSef), xlSheetNm retornará o nome da planilha atual.

Valor de propriedade/Valor de retorno

Retorna o nome da folha (xltypeStr) no formulário [Book1]Sheet1.

Exemplo

O exemplo a seguir exibe o nome da planilha da qual a função foi chamada. A função funciona corretamente somente se for chamada de uma planilha de macro durante a execução de uma macro de comando XLM. Isso ocorre porque ele chama xlcAlert, o que só os comandos podem fazer e precisa ser chamado de uma planilha em vez de uma caixa de diálogo, menu ou barra de comando para que xlfCaller retorne uma referência.

\SAMPLES\EXAMPLE\EXAMPLE.C

short WINAPI xlSheetNmExample(void)
{
   XLOPER12 xRes, xSheetName;
   Excel12(xlfCaller, &xRes, 0);
   Excel12(xlSheetNm, &xSheetName, 1, (LPXLOPER12)&xRes);
   Excel12(xlcAlert, 0, 1, (LPXLOPER12)&xSheetName);
   Excel12(xlFree, 0, 1, (LPXLOPER12)&xSheetName);
   return 1;
}

Confira também