CLUSCTL_RESOURCE_GET_NAME control code

Retrieves the name of a resource. Applications use this control code as a ClusterResourceControl parameter.



ClusterResourceControl( 
  hResource,                                         // resource handle
  hHostNode,                                         // optional host node
  CLUSCTL_RESOURCE_GET_NAME,                         // this control code
  NULL,                                              // input buffer (not used)
  0,                                                 // input buffer size (not used)
  lpOutBuffer,                                       // output buffer: string
  cbOutBufferSize,                                   // allocated buffer size (bytes)
  lpcbBytesReturned );                               // actual size of resulting data (bytes)

Parameters

The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceControl.

lpOutBuffer

On a successful return, points to a null-terminated Unicode string containing the name of the resource.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.

System error code

If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

The name of a resource is stored in the Name property. To retrieve the Name property along with the other read-only resource common properties, use the CLUSCTL_RESOURCE_GET_RO_COMMON_PROPERTIES control code.

Do not use the CLUSCTL_RESOURCE_GET_NAME control code in any resource DLL entry point function. This control code can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_GET_NAME as follows (for more information, see Control Code Architecture).

ComponentBit locationValue
Object code24–31

CLUS_OBJECT_RESOURCE (0x1)

Global bit23

CLUS_NOT_GLOBAL (0x0)

Modify bit22

CLUS_NO_MODIFY (0x0)

User bit21

CLCTL_CLUSTER_BASE (0x0)

Type bit20

External (0x0)

Operation code0–23

CLCTL_GET_NAME (0x29)

Access code0–1

CLUS_ACCESS_READ (0x1)

 

Resource DLL Support

The CLUSCTL_RESOURCE_GET_NAME control code is handled by the Cluster service and is not passed to resource DLLs.

Examples


#include <windows.h>
#include <ClusApi.h>

//////////////////////////////////////////////////////////////////////

#include "ClusDocEx.h"

//////////////////////////////////////////////////////////////////////

#ifndef _CLUSDOCEX_RESGETNAME_CPP
#define _CLUSDOCEX_RESGETNAME_CPP

LPWSTR ClusDocEx_ResGetName
(
    IN HRESOURCE hRes,
    IN HNODE     hNode
)
// ====================================================================
// 
// Description:
// 
//     Retrieves the name of a resource
//     using CLUSCTL_RESOURCE_GET_NAME. 
//     
// 
//     Call LocalFree on the returned pointer to free the memory
// 
// 
// Arguments:
// 
//     IN HRESOURCE hRes       Handle to the resource to affect.
// 
//     IN HNODE     hNode      Optional handle to the node that
//                             owns the resource.
// 
// Return Value:
// 
//     If successful, the name of the resource.
//     If not, a NULL pointer; call GetLastError() for details.
// 
// 
// Local Variables:
// 
//     dwResult      Captures return values.
// 
//     cbBufSize     Byte size of the output buffer.
// 
//     cbResultSize  Actual size of the resulting data.
// 
//     lpszName      Output buffer for the control code operation.
//                   Used as the return value.
// 
// ====================================================================
{
    DWORD  dwResult     = ERROR_SUCCESS;
    DWORD  cbBufSize    = ClusDocEx_DEFAULT_CB;
    DWORD  cbResultSize = 0;
    LPWSTR lpszName     = NULL;

//--------------------------------------------------------------------
//  Allocate the output buffer.
//--------------------------------------------------------------------

    lpszName = (LPWSTR) LocalAlloc( LPTR, cbBufSize );

    if( lpszName == NULL )
    {
        dwResult = GetLastError();
        goto endf;
    }


//--------------------------------------------------------------------
//  Call the control code function.
//--------------------------------------------------------------------
//
//  Use the output configuration:  
//

    dwResult = ClusterResourceControl(
                   hRes,
                   hNode,
                   CLUSCTL_RESOURCE_GET_RESOURCE_TYPE,
                   NULL,
                   0,
                   (LPVOID) lpszName,
                   cbBufSize,
                   &cbResultSize );


//--------------------------------------------------------------------
//  Reallocation routine.
//--------------------------------------------------------------------
//
//  If the buffer was too small, cbResultSize now indicates the
//  necessary byte size.
//
    if ( dwResult == ERROR_MORE_DATA )
    {
        LocalFree( lpszName );

        cbBufSize = cbResultSize;

        lpszName = (LPWSTR) LocalAlloc( LPTR, cbBufSize );

        dwResult = ClusterResourceControl(
                       hRes,
                       hNode,
                       CLUSCTL_RESOURCE_GET_RESOURCE_TYPE,
                       NULL,
                       0,
                       (LPVOID) lpszName,
                       cbBufSize,
                       &cbResultSize );
    }


endf:

    SetLastError( dwResult );

    return lpszName;
}

#endif

// end ClusDocEx_ResGetName


Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Enterprise, Windows Server 2008 Datacenter

Header

ClusAPI.h

See also

External Resource Control Codes
CLUSCTL_RESOURCE_GET_RO_COMMON_PROPERTIES
ClusterResourceControl
Name
ResourceControl

 

 

Show: