Share via

RmGetResourceInfo (Compact 2013)

  • Article

3/26/2014

This function retrieves the current state information of the resource.

Syntax

RM_RESULT RmGetResourceInfo(
    __in HANDLE hId,
    __in const RM_RESOURCE_ID* pResId,
    __out_bcount(cbResourceInfo) RM_RESOURCE_INFO* pResourceInfo,
    DWORD cbResourceInfo
);

Parameters

  • [in] pResId
    [in] An RM_RESOURCE_ID identifying the resource to get information on.

  • [in,out] pResourceInfo
    [in] Pointer to a storage area to place the output.

    [out] Pointer to a RM_RESOURCE_INFO structure.

  • [in] cbResourceInfo
    [in] Number of bytes in the pResourceInfo structure.

Return Value

The function returns the following values:

Value

Description

RMRE_SUCCESS

The call succeeded.

RMRE_INSUFFICIENT_BUFFER

The cbResourceInfo output buffer is too small to contain the results of pResourceInfo.

RMRE_INVALID_PARAMETER

One of the input parameters is invalid.

RMRE_NOT_INITIALIZED

The hId parameter cannot be matched to an initialized resource.

RMRE_RESOURCE_DOES_NOT_EXIST

The pResId parameter cannot be matched with a resource or provider.

RMRE_UNEXPECTED

An unexpected failure occurred.

Requirements

Header

rmnet.h

Library

rmnet.lib

See Also

Reference

Resource Manager Functions
RM_RESOURCE_HANDLE
RM_RESOURCE_ID
RM_RESOURCE_INFO
RmInitialize
Resource Manager Service Provider Reference